1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
获取作业的Pod列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetRayJobPods。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | 任务ID 示例值:rayjob-20260323163852-huvy |
| Page | 否 | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | 否 | Integer | 页数 示例值:10 |
| StartTime | 否 | Integer | 提交时间起始过滤-时间戳(毫秒,可选 示例值:1771862400000 |
| EndTime | 否 | Integer | 提交时间截止过滤-时间戳(毫秒,可选) 示例值:1774454399000 |
| Filters.N | 否 | Array of Filter | 过滤条件(列表名称) |
| SortFields.N | 否 | Array of SortField | 排序字段列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总记录数 示例值:1 |
| Page | Integer | 当前页码(从1开始) 示例值:1 |
| PageSize | Integer | 页数 示例值:10 |
| TotalPages | Integer | 总页数 示例值:1 |
| Items | Array of JobPodEntity | 作业pod列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取作业的Pod列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRayJobPods
<公共请求参数>
{
"Id": "rayjob-20260323163852-huvy",
"Page": 1,
"PageSize": 10,
"StartTime": 1771862400000,
"EndTime": 1774454399000
}
输出示例
{
"Response": {
"Items": [
{
"CpuLimit": "1",
"CpuRequest": "500m",
"CreateTime": 1774255590000,
"GpuCount": "0",
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:3.0.0.dev0-py311-cpu",
"MemoryLimit": "1Gi",
"MemoryRequest": "200Mi",
"Namespace": "dlc-p-ofvhyjzn",
"NodeIp": "169.254.128.2",
"NodeName": "eklet-subnet-l8wxf43i-bd9cv4ef",
"Phase": "Succeeded",
"PodIp": "30.1.0.150",
"PodName": "rayjob-20260323163852-huvy-8qd7h",
"StartTime": 1774255660000,
"Status": "Succeeded"
}
],
"Page": 1,
"PageSize": 10,
"Total": 1,
"TotalPages": 1,
"RequestId": "53c77b8d-4a2b-4eef-957b-868d0e2b6ec5"
}
}
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 | 外部服务异常 |