更新迁移任务策略--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新迁移任务策略

最近更新时间：2024.08.14 11:29:17首次发布时间：2024.05.06 15:18:33

本接口支持通过指定任务 ID 来更新该任务的迁移策略。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
RunStrategy	Object of RunStrategy	是	`-`	调整后的迁移策略
TaskId	String	是	`648c15f764f3c4abd95ad044`	任务ID，请参考GetImageMigrateTasks获取返回的任务 ID。

RunStrategy

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

参数	类型	是否必选	示例值	描述
ReadQps	Array of Integer	否	`[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]`	源下载 QPS 限制。如取值不为空，则长度必须为 24，表示一天 24 小时内各小时的 QPS 限制值。默认无限制。取值为负值时，表示无限制取值为 0 时，表示对应时间不允许迁移
ReadRate	Array of Integer	否	`[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]`	源下载流量限制。单位为 Byte。如取值不为空，则长度必须为24，表示一天 24 小时内各小时的流量限制值。默认无限制。取值为负值时，表示无限制取值为 0 时，表示对应时间不允许迁移

ReadQps

Array of Integer

否

[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]

源下载 QPS 限制。如取值不为空，则长度必须为 24，表示一天 24 小时内各小时的 QPS 限制值。默认无限制。

取值为负值时，表示无限制
取值为 0 时，表示对应时间不允许迁移

ReadRate

Array of Integer

否

[100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]

源下载流量限制。单位为 Byte。如取值不为空，则长度必须为24，表示一天 24 小时内各小时的流量限制值。默认无限制。

取值为负值时，表示无限制
取值为 0 时，表示对应时间不允许迁移

返回参数

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

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageTaskStrategy&Version=2023-05-01
{
    "RunStrategy": {
        "ReadQps": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400],
        "ReadRate": [100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2100, 2200, 2300, 2400]
    },
    "TaskId": "648c15f76***c4abd95ad044"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023061615574388A72E74B3D53A0B790E",
    "Action": "UpdateImageTaskStrategy",
    "Version": "2023-05-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {}
}

错误码

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

服务端 SDK

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

历史版本

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