Obtaining Commands from SMS

Function

This API is called by the migration Agent to obtain commands sent from the SMS server to the migration Agent on a specified source 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	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	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	Error Codes 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	Error Codes 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: 255 characters
encoded_authorization_message	String	Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error message. Array length: 1 to 20

**Table 8** **details** field description
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes 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 10** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes 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

Obtaining commands from SMS succeeded.

{
  "command_name" : "START",
  "command_param" : {
    "task_id" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001"
  }
}

Status code: 403

Authentication failed.

{
  "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."
  } ]
}