文档中心

删除任务执行详情

最近更新时间：2024.01.31 14:29:29

首次发布时间：2023.12.25 16:48:06

本接口支持通过指定任务条目 ID，删除提交任务内对应的该条 URL/URI。

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
EntryId	String	否	`649a9332***80e9cc0a0ec`	待删除的任务条目 ID，您可通过调用GetImageTranscodeDetails获取该账号下全部执行任务条目 ID。
Entries	Array of String	否	`6486g82***82s73h01a`	待删除的任务条目 ID 列表，您可通过调用GetImageTranscodeDetails获取该账号下全部执行任务条目 ID。

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteImageTranscodeDetail&Version=2023-05-01
{
	"EntryId": "",
  "Entries": [
	  6486g82***82s73h01a
	  ],
}

返回示例

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

错误码

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

服务端 SDK

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