Updated on 2022-08-02 GMT+08:00

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.

URI

POST /v3/sources/{server_id}/command_result

Table 1 Path parameter

Parameter

Mandatory

Type

Description

server_id

Yes

String

Specifies 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

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

command_name

Yes

String

Specifies 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

Specifies the command execution result. success: indicates that the command is executed successfully. fail: indicated that the command fails to be executed.

Minimum length: 0 characters

Maximum length: 255 characters

result_detail

Yes

Object

Specifies the command execution result in JSON format. This parameter is used only to save command execution results to the SMS database.

Response

Status code: 400

Table 4 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 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: 403

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

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

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

Example Request

Report a command execution result.

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

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

Example Response

None

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.