1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
本接口（DescribeTaskResult）用于查询任务结果。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTaskResult。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EnvId | 是 | String | 云开发环境ID 示例值：pg-***zgavrt1f14772b |
| TaskId | 是 | String | 任务ID 示例值：task-e6ee5110 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID 示例值：task-e6ee5110 |
| TaskType | String | 任务类型 枚举值：
示例值：PGUserMigration |
| Status | String | 任务状态 枚举值：
示例值：Succeed |
| Phase | String | 当前步骤 示例值：RunMigrations |
| Reason | String | 失败原因 示例值：Out of range value for column 'appid' at row 1 (type: MySQLError, retryable: true) |
| CreatedAt | String | 创建时间 参数格式：2026-05-26T11:26:14+08:00 示例值：2026-05-26T11:26:13+08:00 |
| UpdatedAt | String | 最后更新时间 参数格式：2026-05-26T11:26:14+08:00 示例值：2026-05-26T11:26:14+08:00 |
| Params | Array of ObjectKV | 任务参数 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeTaskResult
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskResult
<公共请求参数>
{
"EnvId": "pg-***********zgavrt1f14772b",
"TaskId": "task-e6ee5110"
}输出示例
{
"Response": {
"CreatedAt": "2026-05-26T11:26:13+08:00",
"Phase": "RunMigrations",
"Reason": "",
"Status": "Succeed",
"TaskId": "task-e6ee5110",
"TaskType": "PGUserMigration",
"UpdatedAt": "2026-05-26T11:26:14+08:00",
"RequestId": "2763d06c-6ee4-4290-b261-479e3ffc670b"
}
}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.SYS_ERR | 系统内部异常。 |
| InvalidParameter.INVALID_PARAM | 请求参数错误。 |
