All Products
Search
Document Center

API Gateway:DescribeInstanceClusterList

Last Updated:Aug 19, 2024

Queries dedicated instance clusters.

Debugging

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

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
apigateway:DescribeInstanceClusterListlist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceClusterNamestringNo

The cluster name.

test-cluster
InstanceClusterIdstringNo

The cluster ID.

apigateway-cluster-hz-xxxxxxxxxxxx
PageSizeintegerNo

The number of entries per page.

10
PageNumberintegerNo

The page number of the page to return.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
TotalCountinteger

The total number of entries returned.

2
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries per page.

10
InstanceClustersarray<object>
object
InstanceClusterNamestring

The cluster name.

test-cluster
InstanceClusterIdstring

The cluster ID.

apigateway-cluster-hz-xxxxxxxxxxxx
Descriptionstring

The cluster description.

Test TrafficControl
CreatedTimestring

The time when the cluster was created. The time is displayed in UTC.

2023-08-14T17:46:59+08:00
ModifiedTimestring

The time when the cluster was last modified. The time is displayed in UTC.

2024-01-12T10:11:08+08:00
RegionIdstring

The region ID of the cluster.

cn-shenzhen
InstanceClusterStatusstring

The cluster status.

RUNNING
InstanceClusterTypestring

The cluster type.

normal

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10,
  "InstanceClusters": {
    "InstanceCluster": [
      {
        "InstanceClusterName": "test-cluster",
        "InstanceClusterId": "apigateway-cluster-hz-xxxxxxxxxxxx\n",
        "Description": "Test TrafficControl",
        "CreatedTime": "2023-08-14T17:46:59+08:00",
        "ModifiedTime": "2024-01-12T10:11:08+08:00",
        "RegionId": "cn-shenzhen",
        "InstanceClusterStatus": "RUNNING",
        "InstanceClusterType": "normal"
      }
    ]
  }
}

Error codes

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