文档首页/ 对象存储迁移服务 OMS/ API参考/ API v2（推荐）/ 迁移任务管理/ 批量更新任务
更新时间：2024-09-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量更新任务

功能介绍

批量更新迁移任务，可指定单个迁移任务组下所有的迁移任务或通过迁移任务ID来执行。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/tasks/batch-update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：1

最大长度：1024

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM Token认证，需要确认Token中包含的Project ID与请求URI中修改资源的Project ID匹配。

最小长度：1

最大长度：16384
表3 请求Body参数

参数

是否必选

参数类型

描述

group_id

否

String

迁移任务组ID，表示批量更新该任务组下所有任务。 group_id和ids为二选一参数，不可同时存在或同时缺失。

最小长度：1

最大长度：36

ids

否

Array of longs

迁移任务id数组，包含所有需要批量更新操作的任务id。 group_id和ids为二选一参数，不可同时存在或同时缺失。

最小值：0

最大值：9223372036854775807

数组长度：0 - 20

bandwidth_policy

是

Array of BandwidthPolicyDto objects

配置流量控制策略。数组中一个元素对应一个时段的最大带宽，最多允许5个时段，且时段不能重叠。

数组长度：0 - 5

task_priority

否

String

任务优先级配置，存在高中低三个优先级档次，限制仅在等待中、已暂停、已失败的任务进行修改 HIGH：高优先级 MEDIUM：中优先级 LOW：低优先级

枚举值：

  • HIGH

  • MEDIUM

  • LOW
表4 BandwidthPolicyDto

参数

是否必选

参数类型

描述

end

是

String

流量控制结束时间（包含），格式为“hh:mm”。例如“12:03”表示12时03分。

max_bandwidth

是

Long

时段内允许的最大流量带宽，单位Byte/s，取值范围为>= 1048576Byte/s（相当于1MB/s）且<=209715200Byte/s（相当于200MB/s）。

最小值：1048576

最大值：209715200

start

是

String

流量控制开始时间（包含），格式为“hh:mm”。例如“12:03”表示12时03分。

响应参数

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息。

error_code

String

错误码。

请求示例

  • 将group_id为xxxxxxxx的任务的限速时段设置为00:01-23:59，限速值设置为50000000Byte/s

    /v2/{project_id}/tasks/batch-update

{
  "group_id" : "xxxxxxxx",
  "bandwidth_policy" : [ {
    "start" : "00:01",
    "end" : "23:59",
    "max_bandwidth" : 50000000
  } ]
}

  • 将id为111,222的任务的限速时段设置为00:01-23:59，限速值设置为50000000Byte/s

    /v2/{project_id}/tasks/batch-update

{
  "ids" : [ 111, 222 ],
  "bandwidth_policy" : [ {
    "start" : "00:01",
    "end" : "23:59",
    "max_bandwidth" : 50000000
  } ]
}

响应示例

无

状态码

状态码

描述

200

OK 批量更新任务操作成功

400

Bad Request 请求参数错误

错误码

请参见错误码。

父主题： 迁移任务管理

相关文档