手动触发任务维度回调--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

手动触发任务维度回调

最近更新时间：2025.01.09 11:23:52首次发布时间：2024.11.29 16:12:07

本接口支持通过指定任务 ID，手动向回调 URL 发送回调信息。回调内容及错误码请参考离线转码说明。

说明

最大一次性可回调 5000 条图片转码执行信息，若任务中超过 5000 条转码图片，将分批发送回调信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=CreateImageTranscodeTaskCallback&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageTranscodeTaskCallback`	接口名称。当前 API 的名称为 `CreateImageTranscodeTaskCallback`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
QueueId	String	是	`63d8f97e60**dffdf7361e`	队列 ID，您可通过调用GetImageTranscodeQueues获取该账号下全部任务队列 ID。
TaskId	String	是	`66f90ed96**20cf6eb0395`	指定队列下的任务 ID，您可通过调用 GetImageTranscodeTasks获取指定队列的全部任务 ID。
Region	String	是	`cn`	队列区域。默认取值 `cn`，表示国内。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageTranscodeTaskCallback&Version=2023-05-01
{
    "TaskId": "66f90ed96**20cf6eb0395",
    "QueueId": "63d8f97e60**dffdf7361e",
    "Region": "cn"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageTranscodeTaskCallback",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。