DescribeCloudAssistantAttributes API for querying Command Assistant information - Simple Application Server - Alibaba Cloud - Simple Application Server

Queries the Cloud Assistant information of one or more instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:DescribeCloudAssistantAttributes

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application servers. You can call ListRegions to query the list of supported Alibaba Cloud regions.	cn-hangzhou
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10
InstanceIds	array	Yes	The instance IDs of the simple application server instances.
	string	No	The instance ID of the simple application server instance.	["2ad1ae67295445f598017499dc**", "2ad1ae67295445f598017123dc**"]

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
CloudAssistant	array<object>	The installation status of Cloud Assistant on the instances.
	object
InstanceId	string	The instance ID of the simple application server instance.	85dbe3e7cc7b49e1a3df4af3bfa4ebbf
CloudAssistantStatus	string	Indicates whether Cloud Assistant is running on the instance. Valid values: true: A heartbeat was detected within the last 2 minutes. false: No heartbeat was detected within the last 2 minutes.	true
LastInvokedTime	string	The time when the last command was executed. The time is displayed in UTC (Z) in the YYYY-MM-DDThh:mm:ssZ format.	2021-03-15T08:00:00Z
CloudAssistantVersion	string	The version number of the Cloud Assistant Agent. This value is empty if the Cloud Assistant Agent is not installed or is not running.	2.2.0.106
ActiveTaskCount	integer	The number of running tasks of Cloud Assistant on the instance.	0
InvocationCount	integer	The number of completed tasks of Cloud Assistant on the instance.	4
LastHeartbeatTime	string	The time of the last heartbeat of Cloud Assistant. This value is updated approximately every minute, with a random fluctuation of up to 5 seconds (minimum 55 seconds, maximum 65 seconds).	2021-03-15T09:00:00Z
OSType	string	The operating system type of the instance. Valid values: Windows. Linux. FreeBSD.	Linux
SupportSessionManager	boolean	Indicates whether Cloud Assistant on the instance supports the session management feature. If session management is not supported, the Cloud Assistant version is outdated. Update the client to the latest version. The minimum Cloud Assistant versions that support session management are as follows: Linux: 2.2.3.189 Windows: 2.1.3.189	true
TotalCount	integer	The total number of entries.	4
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The current page number.	1

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.