文档中心

更新任务配置

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

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

本接口支持通过指定任务 ID 更新对应离线评估任务的配置。

注意事项

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

请求说明

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

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
TaskId	String	是	`65389176**34a65e2ce94`	待更新的任务 ID，您可以通过调用 GetImageAnalyzeTasks 获取指定地区全部离线评估任务详情。
Name	String	是	`test`	任务名称
Desc	String	否	`备注`	任务描述
ServiceId	String	是	`4u**7a`	服务 ID
ResUri	Array of String	否	`["tos-cn-i-4u**7a/StoreUri.txt"]`	txt 评估文件的 Store URI，该文件需上传至指定服务对应存储中。
EvalPerStage	Boolean	否	`false`	仅当`Type` 取值 `UriFile` 时，配置有效。是否模拟模板每阶段输出，取值如下所示： `true`：是，一个模版中可以选择多种图像处理, 模拟输出时会将所有的处理逐步叠加并编码为最终图片格式运行并输出评估结果。 `false`：否。
Tpl	String	否	`tplv-a-xxx`	仅当`Type` 取值 `UriFile` 时，配置有效。模板名称，您可通过调用 GetAllImageTemplates 获取服务下所有已创建的 `TemplateName`。

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageAnalyzeTask&Version=2023-05-01
{
   "Name":"test",
   "Desc":"备注",
   "Type":"UrlFile",
   "ServiceId":"4u**7a",
   "ResUri":[
      "tos-cn-i-4u**7a/StoreUri.txt"
   ],
   "Region":"cn",
   "TaskId":"65389176**34a65e2ce94"
}

返回示例

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

错误码

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

服务端 SDK

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