Query the agent running status on a specified instance.

Request parameters

Name Type Required or not Description
Action String Yes API name specified by the system.  Value: NodeStatus.
InstanceId String Yes Instance id, for example: i-22jja5c2l.

Response parameter

Name Type Description
Error code Integer Error code. The value 200 indicates that the request is successful, and a non-200 value indicates request failure
ErrorMessage String Error message
Success String Whether the operation is successful, which is equivalent to errorCode200.
RequestId String Unique request ID used for error locating.
InstanceId String Instance id
Status String Agent running status
AutoInstall Boolean Whether to enable automatic installation using NodeInstall
Agent running status
Name Description
running Running
Stopped Stopped
not_installed Uninstalled
installing Installing
Install_faild Installation failed
need_to_upgrade Upgrade required
uninstalled Already uninstalled


Request example
&InstanceId= i-abcdefgh123456
&<Common Request Parameters>

Response example

  • XML format
  • <NodeStatusResponse>
      <InstanceId> i-abcdefgh123456</InstanceId>
  • JSON format
  • {
        "InstanceId": " i-abcdefgh123456", 
        "Success": true, 
        "ErrorCode": 200, 
        "AutoInstall": true