All Products
Search
Document Center

Simple Application Server:DescribeCloudAssistantStatus

Last Updated:Oct 30, 2024

Queries whether the Cloud Assistant client is installed on simple application servers.

Operation description

By default, the Cloud Assistant client is installed on simple application servers. If you have manually uninstalled the client, you must reinstall the client. Otherwise, you cannot run commands on the servers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
swas-open:DescribeCloudAssistantStatusget
  • Instance
    acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application servers.

cn-hangzhou
PageNumberintegerNo

The page number.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

Maximum value: 50.

Default value: 10.

10
InstanceIdsarrayNo

The IDs of the simple application servers.

stringNo

The ID of the simple application server.

ace0706b2ac4454d984295a94213****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F****
CloudAssistantStatusarray<object>

Indicates whether the Cloud Assistant client is installed on the server.

statusobject
InstanceIdstring

The ID of the simple application server.

ace0706b2ac4454d984295a94213****
Statusboolean

Indicates whether the Cloud Assistant client is installed on the server.

true
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries per page.

Maximum value: 50.

Default value: 10.

10
PageNumberinteger

The page number.

Pages start from page 1.

Default value: 1.

1

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history