更新时间:2025-02-13 GMT+08:00

查询任务限速规则

功能介绍

按时间段查询迁移任务的迁移速率。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

查询限速信息的任务ID

最小长度:0

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

X-Auth-Token

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

最小长度:1

最大长度:16384

响应参数

状态码:200

表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

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

最小值:0

最大值:100

状态码:403

表5 响应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

表6 details

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度:0

最大长度:65535

error_msg

String

SMS错误信息

最小长度:0

最大长度:65535

请求示例

查询迁移速率

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

响应示例

状态码:200

查询任务限速规则成功

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

状态码: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

鉴权失败

错误码

请参见错误码