DescribeAIDBClusters - 查询AI集群列表_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查看custom集群列表

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeAIDBClusters

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterIds	string	否	集群 ID。多个集群 ID 间用英文逗号（,）隔开。	pc-***************
PageSize	integer	否	每页记录数，取值为 30、50 或 100。默认值为 30。	30
PageNumber	integer	否	页码。	1
DBClusterDescription	string	否	集群描述，可模糊查询。	pc-****************
DBClusterStatus	string	否	集群状态，取值范围如下： Creating：创建中 Running：运行中 Deleting：释放中 Rebooting：重启中 DBNodeCreating：正在增加节点 DBNodeDeleting：正在删除节点 ClassChanging：正在变更节点规格 NetAddressCreating：正在创建网络连接 NetAddressDeleting：正在删除网络连接 NetAddressModifying：正在修改网络连接 Deleted：已释放 ClassChanged：升降配结束资源回收中	Running
PayType	string	否	付费类型，取值范围如下： Postpaid：按量付费 Prepaid：预付费（包年包月）	Prepaid
RegionId	string	是	地域 ID。	cn-hangzhou
AiNodeType	string	否	节点类型。支持多个类型搜索，两个值用逗号隔离： vnode： K8s 纳管 container：可登录容器 maas: 模型服务	vnode,container

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	9D6CE7C6-1C52-5BF6-B3D7-10977D44542C
TotalRecordCount	integer	总记录数。	5
PageRecordCount	integer	当前页面记录数	7
PageNumber	integer	查询页码，默认值为 1。	1
Items	object
DBCluster	array<object>	AI 集群实例列表
	object	AI 集群实例属性
DBClusterId	string	集群 ID。	pc-**************
RegionId	string	地域 ID。	cn-hangzhou
ZoneId	string	可用区 ID。	cn-hangzhou-j
PayType	string	付费类型。取值范围： Postpaid：按量付费。 Prepaid：包年包月（预付费）。	Postpaid
DBClusterStatus	string	集群状态。	Creating
DBClusterDescription	string	集群描述。	ocpx
VpcId	string	访问端点所在的专有网络 ID。	vpc-***************
VswtichId	string	虚拟交换机 ID。	vsw-*********************
DBNodeClass	string	节点规格。	polar.pg.g8.8xlarge.gu30
StorageType	string	存储类型取值如下： essdpl0 essdpl1 essdpl2 essdpl3	essdpl0
StorageSpace	integer	变更后的存储空间。单位：GB。	10
ExpireTime	string	到期时间。说明仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。	2028-09-01T16:00:00Z
Expired	boolean	是否集群已过期。取值范围如下： true false	False
LockMode	string	集群的锁定状态，取值范围如下： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。	Unlock
CreateTime	string	集群创建时间。	2021-09-13T15:45:27Z
KubeClusterId	string	ACK 集群 ID	xxxxxxxxxxxx
RunType	string	运行类型。可选： container：容器 default：节点。	container
DBType	string	数据库引擎类型，当前仅支持polardb_ai类型。	polardb_ai
AiNodeType	string	节点类型。可选： vnode： K8s 纳管 container：可登录容器 maas: 模型服务	vnode

示例

正常返回示例

JSON格式

{
  "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-***************",
        "VswtichId": "vsw-*********************\n",
        "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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。