1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
根据集群ID列出所有Ray任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListRayJobs。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Page | 否 | Integer | 当前页码（从1开始） 示例值：1 |
| PageSize | 否 | Integer | 页数 示例值：100 |
| Filters.N | 否 | Array of Filter | 过滤条件列表（列表的字段名称） |
| StartTime | 否 | Integer | 提交时间起始过滤-时间戳（毫秒，可选） 示例值：1774410300000 |
| EndTime | 否 | Integer | 提交时间截止过滤-时间戳（毫秒，可选） 示例值：1774410400000 |
| SortFields.N | 否 | Array of SortField | 排序字段列表（列表字段） |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Page | Integer | 当前页码（从1开始） 示例值：1 |
| PageSize | Integer | 页数 示例值：100 |
| TotalPages | Integer | 总页数 示例值：1 |
| Items | Array of RayJobSubmitEntity | ray作业列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出所有任务
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRayJobs
<公共请求参数>
{
"Page": 1,
"PageSize": 100,
"StartTime": 1774410300000,
"EndTime": 1774410400000
}输出示例
{
"Response": {
"Items": [
{
"AppId": 260090589,
"AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
"Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
"CreateTime": 1774410317712,
"Entrypoint": "sleep 1",
"ErrorMessage": "提交 RayJob rayjob-20260325114517-sg2m 到 Kubernetes 失败 (namespace: dlc-p-ofvhyjzn)。 原因(reason): Forbidden (HTTP 403)。 详情: admission webhook \"vrayjob.kb.io\" denied the request: spec.rayClusterSpec.enableInTreeAutoscaling: Invalid value: true: a kueue managed job should only use autoscaling when workload slicing is enabled。 建议操作(action): 当前 ServiceAccount 没有创建 RayJob 资源的权限，请检查 RBAC 配置，确保 ServiceAccount 拥有对 rayjobs.ray.io 资源的 create 权限。",
"FinishTime": 1774410319640,
"HistoryUrl": "https://test-tcray-historyserver-guangzhou.cloud.tencent.com/history/dlc-p-ofvhyjzn/rayjob-20260325114517-sg2m/",
"Id": "rayjob-20260325114517-sg2m",
"Image": "ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu",
"ImagePullPolicy": "IfNotPresent",
"JobName": "test1111-20260325114517-sg2m",
"Queue": "default",
"ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":2,\"PodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"HighAvailability\":false,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null},\"Worker\":[{\"Name\":\"Worker01\",\"PodCpu\":1,\"PodMem\":2,\"MinPodNum\":1,\"MaxPodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null}]}",
"ResourcePartitionId": "dlc-p-ofvhyjzn",
"ResourcePartitionName": "甘露-测试04",
"RunningTime": 304,
"RuntimeEnv": "{\"py_modules\":[\"/path/to/my_module\",\"s3://bucket/my_lib.zip\"],\"working_dir\":\"https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip\"}",
"SpecId": "rayjobspec-tcfqaq-hez2",
"SpecName": "test1111",
"Status": "FAILED",
"SubAccountUin": "700002467852",
"Uin": "700002467852"
}
],
"Page": 1,
"PageSize": 100,
"TotalPages": 1,
"RequestId": "6f5d03c4-3ffc-4443-866f-c5d659fe481e"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ExternalService | 外部服务异常 |
