Reporting the Command Execution Result to SMS

Function

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

Calling Method

For details, see Calling APIs.

URI

POST /v3/sources/{server_id}/command_result

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
server_id	Yes	String	The ID of the source server for which the Agent reports the command execution result to SMS. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	No	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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
command_name	Yes	String	The command name. The value can be START, STOP, DELETE, SYNC, UPLOAD_LOG, or RSET_LOG_ACL. Minimum length: 0 characters Maximum length: 255 characters
result	Yes	String	The command execution result.  success: The command is executed successfully.  fail: The command fails to be executed. Minimum length: 0 characters Maximum length: 255 characters
result_detail	Yes	Object	The command execution result in JSON format. This parameter is used only to save command execution results to the SMS database.

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
-	String	Reporting command execution results to SMS succeeded.

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 sends the execution result of a specified command to the SMS server. The command is START, and the execution result is success.

POST https://{endpoint}/v3/sources/f32ab4d6-d150-4fb3-aa55-edbb5cf9xxxx/command_result

{
  "command_name" : "START",
  "result" : "success",
  "result_detail" : {
    "msg" : "xxx"
  }
}

Example Response

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

Status Codes

Status Code	Description
200	Reporting command execution results to SMS succeeded.
400	Bad request.
401	Unauthorized.
403	Authentication failed.
404	Not found.
500	Internal server error.