Query dedicated instance clusters using DescribeInstanceClusterList - API Gateway

Queries dedicated instance clusters.

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

apigateway:DescribeInstanceClusterList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceClusterName	string	No	The cluster name.	test-cluster
InstanceClusterId	string	No	The cluster ID.	apigateway-cluster-hz-xxxxxxxxxxxx
PageSize	integer	No	The number of entries per page.	10
PageNumber	integer	No	The page number of the page to return.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
TotalCount	integer	The total number of entries returned.	2
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10
InstanceClusters	object
InstanceCluster	array<object>	The instance cluster list.
	object
InstanceClusterName	string	The cluster name.	test-cluster
InstanceClusterId	string	The cluster ID.	apigateway-cluster-hz-xxxxxxxxxxxx
Description	string	The cluster description.	Test TrafficControl
CreatedTime	string	The time when the cluster was created. The time is displayed in UTC.	2023-08-14T17:46:59+08:00
ModifiedTime	string	The time when the cluster was last modified. The time is displayed in UTC.	2024-01-12T10:11:08+08:00
RegionId	string	The region ID of the cluster.	cn-hangzhou
InstanceClusterStatus	string	The cluster status.	RUNNING
InstanceClusterType	string	The cluster type.	normal

Examples

Success response

JSON format

{
  "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-hangzhou",
        "InstanceClusterStatus": "RUNNING",
        "InstanceClusterType": "normal"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.