1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
该接口(DescribeTasks)用于查询任务列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeMCPTask。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TaskId | 否 | String | 任务 ID 示例值:** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskInfo | MCPTaskInfo | 任务详细信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 MCP 任务示例
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMCPTask
<公共请求参数>
{
"TaskId": "**"
}
输出示例
{
"Response": {
"TaskInfo": {
"BatchId": "batch-1234567890",
"CreateTime": "2026-07-16 10:00:00",
"DataEngineId": "DataEngine-mock-001",
"DataSet": "[[\"col1\",\"col2\"],[\"value1\",\"value2\"]]",
"DatabaseName": "mock_database",
"EndTime": "2026-07-16 10:00:10",
"EngineTypeDetail": "SparkSQL",
"Id": "11",
"IsSQLCutOff": false,
"OperateUin": "100000000001",
"OutputMessage": "Mock task completed successfully",
"Progress": 100,
"ResourceGroupName": "mock_resource_group",
"SQL": "SELECT * FROM db.table LIMIT 10",
"SQLType": "DQL",
"SparkJobId": "spark-job-mock-001",
"SparkJobName": "mock_spark_job",
"StartTime": "2026-07-16 10:00:01",
"State": 2,
"TaskKind": "SQLTask",
"TaskType": "SQLTask",
"TotalTime": 9500,
"UpdateTime": "2026-07-16 10:00:10",
"UsedTime": 9000
},
"RequestId": "88d52c8f-5baf-4d42-afa7-73bbe0aa7198"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.DBError | 数据库错误。 |
| InternalError.InternalSystemException | 业务系统异常,请重试或提工单联系我们。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.FiltersValuesNumberOutOfLimit | 指定Filter.Values参数数量超限,当前应小于等于50个 |
| InvalidParameter.InvalidFilterLength | 过滤条件个数非法,当指定了过滤条件时,过滤条件的个数应该大于等于1个,且小于等于5个 |
| InvalidParameter.InvalidTimeFormat | 指定时间格式不合规,当前仅支持: YYYY-mm-dd HH:MM:SS |
| InvalidParameter.ParameterBase64DecodeFailed | 指定参数Base64解析失败 |
| InvalidParameter.ParameterNotFoundOrBeNone | 找不到参数或参数为空 |
| InvalidParameter.SQLTaskFiltersKeyTypeNotMath | 指定的Filter.Key不匹配,当前仅支持: task-id/task-sql-keyword/task-kind/task-operator/batch-id/session-id/task-state |
| InvalidParameter.SQLTaskNotFound | 指定的SQL任务不存在 |
| InvalidParameter.SQLTaskSortByTypeNotMatch | SQL任务指定SortBy类型不匹配,当前仅支持: create-time/data-amount/used-time/resource-usage |
| InvalidParameter.SparkJobNotFound | 指定的Spark任务不存在 |
| InvalidParameter.TaskStateTypeNotMath | 指定的任务状态不匹配,当前仅支持: 0:初始化, 1:运行中, 2:成功, 3:数据写入中, 4:排队中, -1:失败, -3:删除 |
| InvalidParameterValue | 参数取值错误。 |