Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ APIs V3.0/ Command Management/ Obtaining Commands from SMS
Updated on 2022-08-02 GMT+08:00
View PDF
Share

Obtaining Commands from SMS

Function

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

URI

GET /v3/sources/{server_id}/command

Table 1 Path parameter

Parameter

Mandatory

Type

Description

server_id

Yes

String

Specifies the source server ID to which the command is sent.

Minimum length: 0 characters

Maximum length: 255 characters

Request

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies 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

Response

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

command_name

String

Specifies the command name. The options can be START, STOP, DELETE, and SYNC.

Minimum length: 0 characters

Maximum length: 255 characters

command_param

ComandParam object

Specifies the command response parameters.
Table 4 ComandParam field description

Parameter

Type

Description

task_id

String

Specifies the task ID.

Minimum length: 0 characters

Maximum length: 255 characters

bucket

String

Specifies 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

Error Codes

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

Specifies 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

Error Codes

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

Specifies 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

Error Codes

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

Specifies 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

Error Codes

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

Specifies 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

Error Codes

Minimum length: 0 characters

Maximum length: 255 characters

error_msg

String

Specifies the error message.

Minimum length: 0 characters

Maximum length: 1,024 characters

Example Request

Obtain 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

See Error Codes.

Parent topic: Command Management