All Products
Search
Document Center

Simple Application Server:ListInstanceStatus

Last Updated:Oct 30, 2024

Queries the status of simple application 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:ListInstanceStatusget
  • Instance
    acs:swas-open:{#regionId}:{#accountId}:{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application servers. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdsstringNo

The IDs of the simple application servers. The value can be a JSON array that consists of up to 100 simple application server IDs. Separate multiple server IDs with commas (,).

["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object
InstanceStatusesarray<object>

The ID of the simple application server.

InstanceStatuseobject

The status information of the instances.

Statusstring

The status of the simple application server. Valid values:

  • Pending
  • Starting
  • Running
  • Stopping
  • Stopped
  • Resetting
  • Upgrading
  • Disabled
Running
InstanceIdstring

The ID of the simple application server.

a9a6474b935d41bcb531250bb5d****
RequestIdstring

The request ID.

30637AD6-D977-4833-A54C-CC89483E****
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of entries returned.

54

Examples

Sample success responses

JSONformat

{
  "InstanceStatuses": [
    {
      "Status": "Running",
      "InstanceId": "a9a6474b935d41bcb531250bb5d****"
    }
  ],
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 54
}

Error codes

HTTP status codeError codeError message
500InternalErrorAn error occurred while processing your request.

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