1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
查询作业完整详情 Action。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeJobDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| JobId | 是 | String | 作业唯一标识符(ID)。必填。 示例值:string |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobDetail | JobDetailInfo | 作业详情,JSON 嵌套在 JobDetail 键下。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询作业详情
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeJobDetail
<公共请求参数>
{
"JobId": "job-9f3a2b1c"
}
输出示例
{
"Response": {
"JobDetail": {
"JobId": "job-9f3a2b1c",
"JobName": "spark-sql-demo",
"CreatorSubUin": "700281534962",
"State": "SUCCEEDED",
"MajorType": "SPARK",
"MinorType": "SPARK_SQL",
"RunMode": "WAREHOUSE",
"WarehouseId": "wh-8f21c3",
"PartitionCode": "dlc-p-nwruuglc",
"PartitionName": "spark-demo-partition",
"QueueName": "root.default",
"CheckpointLocation": "cosn://demo-bucket/checkpoints/demo_stream",
"CreateTime": 1767256876123,
"SubmitTime": 1767256876123,
"FinishTime": 1767256876123,
"RunningTimeMs": 900000,
"WarehouseName": "spark-warehouse",
"FlowId": "flow-2a9c4e",
"ExecutionId": "exec-6f1b83",
"JobSource": "手动触发",
"WaitingTimeMs": 900000,
"HistoryUrl": "https://spark-history.demo/job-9f3a2b1c",
"ErrorMessage": "详见作业日志",
"CustomProperties": "{\"spark.executor.memory\":\"4g\"}",
"EnvVars": [
{
"Key": "spark.executor.memory",
"Value": "4g"
}
],
"RuntimeCode": "spark-3.5.5",
"RuntimeName": "Spark 3.5.5",
"SysCatalogVersion": "TCCATALOG"
},
"RequestId": "f4a1c9b2-7d3e-4a58-9c62-1e8b5d7a2f43"
}
}
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.ApiCallFailed | 调用下游计费接口失败,资源销毁通知未送达 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied.ServiceNotActivated | 服务未开通 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Warehouse | 计算引擎不存在 |
| UnauthorizedOperation | 未授权操作。 |