手动触发回调--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

手动触发回调

最近更新时间：2024.08.14 11:29:15首次发布时间：2023.12.25 16:48:05

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

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
EntryId	String	是	`649a9332***0e9cc0a0ed`	任务条目 ID

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageTranscodeCallback&Version=2023-05-01
{
  "EntryId": "649a9332***0e9cc0a0ed"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "CreateImageTranscodeCallback",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

历史版本

2018-08-01 版本 CreateImageTranscodeCallback 接口文档现已停止维护，建议您参考本文档使用最新版本。