1. 接口描述
接口请求域名： oceanus.tencentcloudapi.com 。
获取作业运行时的信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeJobRuntimeInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 作业ID 示例值：cql-xxx |
| WorkSpaceId | 是 | String | 工作空间ID 示例值：space-xxx |
| IncludeInfo.N | 是 | Array of String | 作业运行信息 key 示例值：["TaskManagers","SubTasks"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobRuntimeInfo | Array of JobRuntimeInfo | 作业运行时信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询作业的taskmanger和subtask
查询作业的taskmanger和subtask
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeJobRuntimeInfo
<公共请求参数>
{
"JobId": "cql-xxx",
"WorkSpaceId": "space-xxx",
"IncludeInfo": [
"TaskManagers",
"SubTasks"
]
}输出示例
{
"Response": {
"JobRuntimeInfo": [
{
"Key": "TaskManagers",
"Value": "WyJjcWwtbDkzZzJ3eGotNDI0MS10YXNrbWFuYWdlci0xLTEiXQ=="
},
{
"Key": "SubTasks",
"Value": "W3siVGFza0lkIjoiY2JjMzU3Y2NiNzYzZGYyODUyZmVlOGM0ZmM3ZDU1ZjIiLCJUYXNrRGVzY3JpcHRpb24iOiJTb3VyY2U6IFRhYmxlU291cmNlU2Nhbih0YWJsZT1bW2RlZmF1bHRfY2F0YWxvZywgZGVmYXVsdF9kYXRhYmFzZSwgZGF0YWdlbl9zb3VyY2VfdGFibGVdXSwgZmllbGRzPVtpZCwgbmFtZV0pIC1cdTAwMjZndDsgU2luazogU2luayh0YWJsZT1bZGVmYXVsdF9jYXRhbG9nLmRlZmF1bHRfZGF0YWJhc2UubG9nZ2VyX3NpbmtfdGFibGVdLCBmaWVsZHM9W2lkLCBuYW1lXSlfMCIsIlN1YlRhc2tJbmRleCI6MH1d"
}
],
"RequestId": "51964833-6e61-4909-b93b-3d4996c9360d"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
