1. 接口描述
接口请求域名： aiart.tencentcloudapi.com 。
查询图片特效任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTemplateToImageJob。 |
| Version | 是 | String | 公共参数，本接口取值：2022-12-29。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| JobId | 是 | String | 任务 ID。 示例值：1394637692053602304 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 当前任务状态码： 1：等待中、2：运行中、4：处理失败、5：处理完成。 示例值：DONE |
| ErrorCode | String | 任务处理失败错误码。 示例值：FailedOperation.Unknown |
| ErrorMessage | String | 任务处理失败错误信息。 示例值：未知错误。 |
| ResultImage | Array of String | 生成图 URL 列表，有效期1小时，请及时保存。 示例值：["https://.cos.ap-guangzhou.tencentcos.cn/imagestyle/results//b1759140-6951-4d6a-9f12-add42ca16b***ey-time=1766401936%3B1766488336&q-header-list=host&q-url-param-list=&q-signature=dfea613edc2ee44c44ee1c4be393ea355cfa5487"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用成功示例
输入示例
POST / HTTP/1.1
Host: aiart.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplateToImageJob
<公共请求参数>
{
"JobId": "1394637692053602304"
}输出示例
{
"Response": {
"ErrorCode": "",
"ErrorMessage": "",
"ResultImage": [
"https://***.tencentcos.cn/imagestyle/results/***/b1759140-6951-4d6a-9f12-add42ca16b***ey-time=1766401936%3B1766488336&q-header-list=host&q-url-param-list=&q-signature=dfea613edc2ee44c44ee1c4be393ea355cfa5487"
],
"Status": "DONE",
"RequestId": "1378c58c-f636-42c2-a5fd-814d3c24e594"
}
}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.JobNotExist | 任务不存在。 |
| FailedOperation.ServerError | 服务内部错误。 |
| OperationDenied.ImageIllegalDetected | 图片包含违法违规信息，审核不通过。 |
