文档首页/ 主机迁移服务 SMS/ API参考（联盟区域）/ API/ 任务管理/ 设置迁移限速规则
更新时间：2025-12-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置迁移限速规则

功能介绍

设置迁移任务的迁移速率。

调用方法

请参见如何调用API。

URI

POST /v3/tasks/{task_id}/speed-limit

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

主机迁移任务的ID

最小长度：1

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

X-Auth-Token

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度：1

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

参数

是否必选

参数类型

描述

speed_limit

是

Array of SpeedLimitlJson objects

按时间段限速信息

数组长度：0 - 65535
表4 SpeedLimitlJson

参数

是否必选

参数类型

描述

start

是

String

时间段开始时间，格式：XX:XX。

最小长度：0

最大长度：255

end

是

String

时间段结束时间，格式：XX:XX。

最小长度：0

最大长度：255

speed

是

Integer

时间段的速率，0-1000的整数，单位：Mbit/s。

最小值：0

最大值：10000

over_speed_threshold

否

Double

停止迁移的超速阈值。 是一个迁移速率的保护机制，超出该阈值会停止任务。它主要用于控制迁移过程中资源（特别是网络带宽）的消耗，确保系统的整体性能不受单一迁移任务影响 单位是百分比

最小值：10

最大值：100

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

-

String

设置迁移限速规则成功

状态码：403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误代码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：255

encoded_authorization_message

String

加密授权信息

最小长度：0

最大长度：65535

error_param

Array of strings

错误参数

最小长度：0

最大长度：65535

数组长度：1 - 20

details

Array of details objects

详细错误信息

数组长度：1 - 20
表7 details

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度：0

最大长度：65535

error_msg

String

SMS错误信息

最小长度：0

最大长度：65535

请求示例

  • 设置迁移任务的迁移速率和停止迁移的阈值速率，0:00到8:00是20M/s，8:00到15:00是50M/s，15:00到23:59是25M/s。

    POST https://{endpoint}/v3/tasks/7a9a9540-ff28-4869-b9e4-855fbe12xxxx/speed-limit

{
  "speed_limit" : [ {
    "start" : "00:00",
    "end" : "23:59",
    "speed" : 1000,
    "over_speed_threshold" : 50.0
  } ]
}

  • 更新ID为a45a300b-86b5-4b13-8802-52274fa43016的迁移速率。

    POST https://{endpoint}/v3/tasks/a45a300b-86b5-4b13-8802-52274fa43016/speed-limit

{
  "speed_limit" : [ {
    "start" : "0:00",
    "end" : "8:00",
    "speed" : 20
  }, {
    "start" : "8:00",
    "end" : "15:00",
    "speed" : 50
  }, {
    "start" : "15:00",
    "end" : "23:59",
    "speed" : 25
  } ]
}

响应示例

状态码：200

设置迁移限速规则成功

{ }

状态码：403

鉴权失败

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}

状态码

状态码

描述

200

设置迁移限速规则成功

403

鉴权失败

错误码

请参见错误码。

父主题： 任务管理