DescribeCloudAssistantStatus - Query Cloud Assistant installation status - Simple Application Server

Operation description

Cloud Assistant is installed on simple application servers by default. If you manually uninstalled it, reinstall the client to use the command execution feature.

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

get

*Instance

acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application servers.	cn-hangzhou
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
InstanceIds	array	No	The IDs of the simple application servers.
	string	No	The ID of the simple application server.	ace0706b2ac4454d984295a94213****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	20758A-585D-4A41-A9B2-28DA8F4F****
CloudAssistantStatus	array<object>	The Cloud Assistant installation status of each server.
	object
InstanceId	string	The ID of the simple application server.	ace0706b2ac4454d984295a94213****
Status	boolean	Whether Cloud Assistant is installed on the server.	true
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries per page. Maximum value: 50. Default value: 10.	10
PageNumber	integer	The page number. Minimum value: 1. Default value: 1.	1

Examples

Success response

JSON format

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "CloudAssistantStatus": [
    {
      "InstanceId": "ace0706b2ac4454d984295a94213****",
      "Status": true
    }
  ],
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.