文档中心

更新任务状态

最近更新时间：2024.01.31 14:31:12

首次发布时间：2023.12.28 11:22:03

本接口支持更新指定的离线画质任务状态。

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Body

参数类型是否必选示例值描述

TaskId String 是 981820****9183720 待更新的任务 ID，您可以通过调用 GetImageAnalyzeTasks 获取指定地区全部离线评估任务 ID。

参数	类型	是否必选	示例值	描述
TaskId	String	是	`981820****9183720`	待更新的任务 ID，您可以通过调用 GetImageAnalyzeTasks 获取指定地区全部离线评估任务 ID。
Status	String	是	`Runing`	指定更新后的任务状态。取值如下所示： `Running`：进行中 `Suspend`：暂停 `Done`：结束

Status

String

是

Runing

指定更新后的任务状态。取值如下所示：

Running：进行中
Suspend：暂停
Done：结束

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageAnalyzeTaskStatus&Version=2023-05-01
{
  "TaskId": "658bc51***3fde951f7",
  "Status": "Runing"
}

返回示例

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

错误码

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

服务端 SDK

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