Updated on 2022-08-05 GMT+08:00

Querying the Migration Rate

Function

This API is used to search the migration rate of a migration task by a time segment.

URI

GET /v1/sms/tasks/{task_id}/speed-limit

For details about the parameters, see Table 1.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

task_id

Yes

String

Specifies the migration task ID. You can view the ID list using the API in Querying the List of Migration Tasks.

Request

N/A

Response

Table 2 Response

Parameter

Type

Description

speed_limit

JSON array

Specifies the information about the time segment when the migration rate is limited. For details, see Table 3.

Table 3 speed_limit data structure

Parameter

Type

Description

start

String

Specifies the start time of a segment. The format is: XX:XX.

end

String

Specifies the end time of a segment. The format is: XX:XX.

speed

Integer

Specifies the migration rate in a time segment. The value is an integer ranging from 0 to 1000. Unit: Mbit/s.

Example

  • Example request
    GET /v1/sms/tasks/c3408583-23a8-490b-8d20-ee88bafe6c96/speed-limit
  • Example response
    {
        "speed_limit": [
            {
                "start": "0:00",
                "end": "8:00",
                "speed": 20
            },
            {
                "start": "8:00",
                "end": "15:00",
                "speed": 50
            },
            {
                "start": "15:00",
                "end": "24:00",
                "speed": 25
            }
        ]
    }

Status Codes

See Status Codes.

Error Codes

See Out-of-Date Error Codes.