Help Center/ Server Migration Service/ API Reference/ API/ Command Management/ Obtaining Commands from SMS
Updated on 2025-09-16 GMT+08:00
View PDF

Obtaining Commands from SMS

Function

This API is called by the migration Agent on source servers to obtain commands from the SMS server.

Calling Method

For details, see Calling APIs.

URI

GET /v3/sources/{server_id}/command

Table 1 Path parameter

Parameter

Mandatory

Type

Description

server_id

Yes

String

The ID of the source server that the command is sent to.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

X-Auth-Token

The user token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum length: 1 character

Maximum length: 16,384 characters

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

command_name

String

The command name. The options are START, STOP, DELETE, and SYNC.

Minimum length: 0 characters

Maximum length: 255 characters

command_param

ComandParam object

The command response parameters.
Table 4 ComandParam field description

Parameter

Type

Description

task_id

String

The task ID.

Minimum length: 0 characters

Maximum length: 255 characters

bucket

String

The bucket name.

Minimum length: 0 characters

Maximum length: 255 characters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

The error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

Example Request

This example obtains the command sent to the Agent installed on the source server whose ID is f32ab4d6-d150-4fb3-aa55-edbb5cf9947f.

GET https://{endpoint}/v3/sources/f32ab4d6-d150-4fb3-aa55-edbb5cf9947f/command

Example Response

Status code: 200

OK

{
  "command_name" : "START",
  "command_param" : {
    "task_id" : "2c0689c860ad4728a497c91ec0844384"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad request.

401

Unauthorized.

403

Forbidden

404

Not found.

500

Internal server error.

Error Codes

For details, see Error Codes.

Parent topic: Command Management