1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
分页查询作业配置列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListJobSpecs。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Page | 否 | Integer | 页数 示例值:1 |
| PageSize | 否 | Integer | 页数 示例值:100 |
| Filters.N | 否 | Array of Filter | 过滤条件 |
| StartTime | 否 | Integer | 创建时间范围 - 开始时间(时间戳(毫秒)) 单位:ms 示例值:1774357934233 |
| EndTime | 否 | Integer | 创建时间范围 - 结束时间(时间戳(毫秒)) 单位:ms 示例值:1774357993696 |
| SortFields.N | 否 | Array of SortField | 排序字段列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数量 示例值:2 |
| Page | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | Integer | 页数 示例值:100 |
| TotalPages | Integer | 总页数 示例值:1 |
| Items | Array of JobSpec | 作业配置列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出作业配置列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListJobSpecs
<公共请求参数>
{
"Page": 1,
"PageSize": 100,
"StartTime": 1774357934233,
"EndTime": 1774357993696
}
输出示例
{
"Response": {
"Items": [
{
"AppId": 1300057089,
"AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
"Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
"ClusterGroup": "rayCluster",
"CreateTime": 1774357993693,
"Description": "rayjob-spec desc",
"Entrypoint": "sleep 1",
"HasRunningJobs": false,
"Id": "rayjobspec-tcene1-2onj",
"Image": "ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu",
"ImagePullPolicy": "IfNotPresent",
"ImagePullType": "Builtin",
"JobInstanceCount": 0,
"JobPackage": "https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip",
"JobPackageName": "test.zip",
"Name": "rayjob-spec-2",
"Queue": "default",
"ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"PodNum\":1,\"HighAvailability\":false},\"Worker\":[{\"Name\":\"Worker01\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"MinPodNum\":1,\"MaxPodNum\":1}]}",
"ResourceConfigId": "ccbe672e-44be-4518-bcdf-ff85189f7059",
"ResourcePartitionId": "dlc-p-ofvhyjzn",
"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\"}",
"SubAccountUin": "600000563453",
"Uin": "600000563453",
"UpdateTime": 1774357993696
}
],
"Page": 1,
"PageSize": 100,
"Total": 2,
"TotalPages": 1,
"RequestId": "f21b5644-79ae-4007-b56f-88b8715b254a"
}
}
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 | 外部服务异常 |