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

文档中心

立即注册

导航

veImageX

更新迁移任务策略

最近更新时间：2024.08.05 18:26:11首次发布时间：2023.07.03 19:37:52

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

说明

该接口属于历史版本 API，建议您使用新版 UpdateImageTaskStrategy 接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间约 10 秒。

请求说明

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

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageTaskStrategy`	接口名称。`UpdateImageTaskStrategy`
Version	String	是	`2018-08-01`	接口版本。

Body

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

RunStrategy

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

参数	类型	是否必选	示例值	描述
ReadQps	Integer Array	否	`{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	Integer Array	否	`{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

Integer Array

否

{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

Integer Array

否

{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=2018-08-01
{
	"TaskId": "648c15f764f3c4abd95ad044",
	"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}"
	}
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023061615574388A72E74B3D53A0B790E",
        "Action": "UpdateImageTaskStrategy",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。