DescribeAIDBClusters-阿里云帮助中心

Queries the list of custom 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

polardb:DescribeAIDBClusters

get

*AICluster

acs:polardb:{#regionId}:{#accountId}:aicluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterIds	string	No	The cluster IDs. Separate multiple cluster IDs with commas (,).	pc-***************
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The page number.	1
DBClusterDescription	string	No	The cluster description. Fuzzy match is supported.	pc-****************
DBClusterStatus	string	No	The cluster status. Valid values: Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being released. Rebooting: The cluster is being restarted. DBNodeCreating: Nodes are being increased. DBNodeDeleting: Nodes are being deleted. ClassChanging: The node specifications are being changed. NetAddressCreating: The network connectivity is being created. NetAddressDeleting: The network connectivity is being deleted. NetAddressModifying: The network connectivity is being modified. Deleted: The cluster is released. ClassChanged: Resources are being revoked after an upgrade or decrease the quota.	Running
PayType	string	No	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
RegionId	string	Yes	The region ID.	cn-hangzhou
AiNodeType	string	No	The node type. You can specify multiple types separated by commas (,). Valid values: vnode: managed by Kubernetes. container: logon-enabled container. maas: model service.	vnode,container
Tag	array<object>	No	The tag list.
	object	No
Key	string	No	The tag key. You can use tags to filter the cluster list. You can specify up to 20 tag key-value pairs. The number n in each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key is Tag.n.Value.	testKey
Value	string	No	The tag value that corresponds to the tag key.	testValueData

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	9D6CE7C6-1C52-5BF6-B3D7-10977D44542C
TotalRecordCount	integer	The total number of entries.	5
PageRecordCount	integer	The number of entries on the current page.	7
PageNumber	integer	The page number. Default value: 1.	1
Items	object
DBCluster	array<object>	The list of AI cluster instances.
	array<object>	The attributes of the AI cluster instance.
DBClusterId	string	The cluster ID.	pc-**************
RegionId	string	The region ID.	cn-hangzhou
ZoneId	string	The zone ID.	cn-hangzhou-j
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DBClusterStatus	string	The cluster status.	Creating
DBClusterDescription	string	The cluster description.	ocpx
VpcId	string	The ID of the virtual private cloud (VPC) where the endpoint resides.	vpc-***************
DBNodeClass	string	The node specifications.	polar.pg.g8.8xlarge.gu30
StorageType	string	The storage type. Valid values: essdpl0 essdpl1 essdpl2 essdpl3	essdpl0
StorageSpace	integer	The storage space after the change. Unit: GB.	10
ExpireTime	string	The expiration time. Note This parameter is returned only for subscription clusters. For pay-as-you-go clusters, an empty value is returned. The expiration time of the AI cluster follows the ISO 8601 UTC format (YYYY-MM-DDThh:mm:ssZ).	2028-09-01T16:00:00Z
Expired	boolean	Indicates whether the cluster has expired. Valid values: true false	False
LockMode	string	The lock status of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked due to expiration.	Unlock
CreateTime	string	The time when the cluster was created. The creation time of the AI cluster follows the ISO 8601 UTC format (YYYY-MM-DDThh:mm:ssZ).	2021-09-13T15:45:27Z
KubeClusterId	string	The ID of the ACK cluster.	xxxxxxxxxxxx
RunType	string	The runtime type. Valid values: container: container. default: node.	container
DBType	string	The database engine type. Only polardb_ai is supported.	polardb_ai
AiNodeType	string	The node type. Valid values: vnode: managed by Kubernetes. container: logon-enabled container. maas: model service.	vnode
Tags	object
Tag	array<object>	The tag list.
	object	The tag key. You can use tags to filter the cluster list. You can specify up to 20 tag key-value pairs. The number n in each tag pair must be unique and must be a consecutive integer starting from 1. The value of Tag.n.Key is Tag.n.Value.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValueData
VswitchId	string	The vSwitch ID.	vsw-**************
RelativeDBClusterId	string	The integrated cluster instance ID.	pc-**************
ModelType	string	The model type.	custom
ModelSpace	string	The model space information.	pms-xxx

Examples

Success response

JSON format

{
  "RequestId": "9D6CE7C6-1C52-5BF6-B3D7-10977D44542C",
  "TotalRecordCount": 5,
  "PageRecordCount": 7,
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DBClusterId": "pc-**************",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-j",
        "PayType": "Postpaid",
        "DBClusterStatus": "Creating",
        "DBClusterDescription": "ocpx",
        "VpcId": "vpc-***************",
        "DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
        "StorageType": "essdpl0",
        "StorageSpace": 10,
        "ExpireTime": "2028-09-01T16:00:00Z",
        "Expired": true,
        "LockMode": "Unlock",
        "CreateTime": "2021-09-13T15:45:27Z",
        "KubeClusterId": "xxxxxxxxxxxx",
        "RunType": "container",
        "DBType": "polardb_ai",
        "AiNodeType": "vnode",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValueData"
            }
          ]
        },
        "VswitchId": "vsw-**************",
        "RelativeDBClusterId": "pc-**************",
        "ModelType": "custom",
        "ModelSpace": "pms-xxx"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.