On this page

Function
Calling Method
URI
Request
Response
Example Request
Example Response
Status Codes
Error Codes

Show all

Help Center/ Server Migration Service/ API Reference/ APIs V3.0/ Command Management/ Obtaining Commands from SMS

Obtaining Commands from SMS

Updated on 2024-09-04 GMT+08:00

View PDF

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	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	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	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: 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	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	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

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

Status Codes

Status Code	Description
200	Response returned.
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

Previous topic: Command Management

Next topic: Reporting the Command Execution Result to SMS

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel