1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
通过任务 ID 查询任务的执行状态和结果的详细信息(最多可以查询7天之内提交的任务)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeImageTaskDetail。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TaskId | 是 | String | 图片处理任务的任务 ID。 示例值:235303-WorkflowTask-80108cc3380155d98b2e3573a48a** |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskType | String | 任务类型,目前取值有: 注意:此字段可能返回 null,表示取不到有效值。 示例值:WorkflowTask |
Status | String | 任务状态,取值: 注意:此字段可能返回 null,表示取不到有效值。 示例值:FINISH |
ImageProcessTaskResultSet | Array of ImageProcessTaskResult | 图片处理任务的执行状态与结果。 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 任务的创建时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:27Z |
FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:46Z |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取任务详情
查询任务结果
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageTaskDetail
<公共请求参数>
{
"TaskId": "24000089-WorkflowTask-0723542d0c164c958ba116874fa9b0c4"
}
输出示例
{
"Response": {
"CreateTime": "2025-05-16T07:44:26Z",
"FinishTime": "2025-05-16T07:44:30Z",
"RequestId": "147e6b46-efeb-48cf-9186-b195b2bf4f9d",
"Status": "FINISH",
"TaskType": "WorkflowTask"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InvalidMpsUser | 操作失败:非法 mps 用户。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |