Querying the Migration Rate Limit Rules of a Migration Task

This API is used to query the time segment-based migration rate limiting rules of a migration task.

For details, see Calling APIs.

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

Table 1 Path parameter
Parameter	Mandatory	Type	Description
task_id	Yes	String	The ID of the task for which you want to query the rate limit rules Minimum length: 0 characters Maximum length: 255 characters

Table 2 Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 character Maximum length: 16,384 characters

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
speed_limit	Array of SpeedLimitlJson objects	The information about the time segments when the migration rate is limited. Array length: 0 to 65,535 characters

Table 4 SpeedLimitlJson field description
Parameter	Type	Description
start	String	The start time of a segment. The format is XX:XX. Minimum length: 0 characters Maximum length: 255 characters
end	String	The end time of a segment. The format is XX:XX. Minimum length: 0 characters Maximum length: 255 characters
speed	Integer	The migration rate during a specified period of time. The value is an integer ranging from 0 to 1000. The unit is Mbit/s. Minimum value: 0 Maximum value: 10000

Query the migration rate limit rules of the task whose ID is 7a9a9540-ff28-4869-b9e4-855fbe12xxxx.

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

Status code: 200

{
  "speed_limit" : [ {
    "start" : "00:00",
    "end" : "23:59",
    "speed" : 0
  } ]
}

Status Code	Description
200	Response returned.

For details, see Error Codes.

Была ли эта статья полезна?