Help Center/ Server Migration Service/ API Reference (Kuala Lumpur Region)/ Out-of-Date APIs/ Command Management/ Reporting the Migration Command Execution Result to the SMS Server
Updated on 2022-08-02 GMT+08:00
View PDF
Share

Reporting the Migration Command Execution Result to the SMS Server

Function

This API is called by the migration Agent to send the execution result of a specified command to the SMS server.

This API is automatically called by the migration Agent to report migration command execution result to the SMS server. You do not need to make calls to this API.

URI

POST /v1/sms/sources/{source_id}/command_result

For details about the parameters, see Table 1.
Table 1 Parameter description

Parameter

Mandatory

Description

source_id

Yes

Specifies the source server ID.

Request

Request parameters

For details about the request parameters, see Table 2.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

command_name

Yes

String

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

result

Yes

String

Specifies the command output.

  • success: indicates that the migration command is executed successfully.
  • fail: The migration command fails to be executed.

result_detail

Yes

Json

Specifies the migration command execution result in JSON format.

Response

None

Example

  • Example request 
    {
"command_name":"START",
"result":"success",
"result_detail":{
"key1": "value1",
"key2": "value2"
}
}
  • Example response

    None

Status Codes

See Status Codes.

Parent topic: Command Management