DescribeCloudAssistantAttributes - Simple Application Server

Queries the Command Assistant information of simple application servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the specified simple application server. You can call the ListRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10
InstanceIds	array	Yes	The IDs of the simple application servers.
	string	Yes	The ID of the simple application server.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
CloudAssistant	object []	The Command Assistant information.
InstanceId	string	The ID of the simple application server.	85dbe3e7cc7b49e1a3df4af3bfa4ebbf
CloudAssistantStatus	string	Indicates whether Command Assistant is running. Valid values: true: Heartbeats are detected in the last 2 minutes. false: Heartbeats are not detected in the last 2 minutes.	true
LastInvokedTime	string	The time when commands were last run.	2021-03-15T08:00:00Z
CloudAssistantVersion	string	The version number of the Command Assistant agent. Null is returned if the Command Assistant agent is not installed or is not running.	2.2.0.106
ActiveTaskCount	long	The number of active tasks in Command Assistant.	0
InvocationCount	long	The number of completed tasks in Command Assistant.	4
LastHeartbeatTime	string	The time when the last heartbeat of Command Assistant was detected. The value is updated every minute on average. The interval can be 55, 60, or 65 seconds.	2021-03-15T09:00:00Z
OSType	string	The OS type of the simple application server. Valid values: Windows Linux FreeBSD	Linux
SupportSessionManager	boolean	Indicates whether Command Assistant supports session management. If Command Assistant does not support session management, the version of the Command Assistant agent is too earlier. We recommend that you update your Command Assistant agent to the latest version. To use the session management feature, you must make sure that the version of your Command Assistant agent meets one of the following requirements: If your simple application server runs Linux, the version of the Command Assistant agent on the server must be 2.2.3.189 or later. If your simple application server runs Windows, the version of the Command Assistant agent on the server must be 2.1.3.189 or later.	true
TotalCount	integer	The total number of entries.	4
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "CloudAssistant": [
    {
      "InstanceId": "85dbe3e7cc7b49e1a3df4af3bfa4ebbf",
      "CloudAssistantStatus": "true",
      "LastInvokedTime": "2021-03-15T08:00:00Z\n",
      "CloudAssistantVersion": "2.2.0.106\n",
      "ActiveTaskCount": 0,
      "InvocationCount": 4,
      "LastHeartbeatTime": "2021-03-15T09:00:00Z\n",
      "OSType": "Linux",
      "SupportSessionManager": true
    }
  ],
  "TotalCount": 4,
  "PageSize": 10,
  "PageNumber": 1
}

Error codes

For a list of error codes, visit the Service error codes.