DescribeAIDBClusterAttribute API的请求与返回参数-云原生数据库 PolarDB-阿里云-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查看custom实例详情

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeAIDBClusterAttribute

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-****************

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	EBEAA83D-1734-42E3-85E3-E25F6E******
DBClusterId	string	集群 ID。	pc-**************
DBClusterStatus	string	集群状态，取值范围如下： Creating：创建中 Running：运行中 Deleting：释放中 DBNodeCreating：正在增加节点 DBNodeDeleting：正在删除节点 ClassChanging：正在变更节点规格 Deleted：已释放	Running
DBClusterDescription	string	集群描述，可模糊查询。	test
RegionId	string	地域 ID。	cn-hangzhou
ZoneId	string	PolarDB 集群节点的可用区 ID。	cn-hangzhou-d
VPCId	string	切换可用区支持指定的专有网络 ID。	vpc-*******************
VSwitchId	string	虚拟交换机 ID。说明如果已选择 VPCId，则 VSwitchId 必选。	vsw-*********************
InternalIp	string	内网 IP	10...72
StorageType	string	企业版存储类型取值如下： PSL5 PSL4 标准版存储类型取值如下： ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	essdpl1
DBNodes	array<object>	节点信息详情。
	array<object>	节点信息详情。
DBNodeClass	string	集群规格	polar.pg.g8.8xlarge.gu30
CpuCores	string	节点 CPU 核数。	2
MemorySize	string	节点内存大小，单位：MB。	8192
GPU	string	GPU 卡数。	2
DBNodeId	string	节点 ID。	pi-****************
DBNodeDescription	string	节点描述。	test
VSwitchId	string	虚拟交换机 ID。	vsw-*********************
VPCId	string	专有网络 ID。	vpc-*******************
DBNodeStatus	string	节点状态，取值范围如下： Creating：创建中 Running：运行中 Deleting：删除中 Rebooting：重启中 DBNodeCreating：正在增加节点 DBNodeDeleting：正在删除节点 ClassChanging：正在变更节点规格 MinorVersionUpgrading：小版本升级中 Maintaining：实例维护中 Switching：切换中	Running
ZoneId	string	可用区。	cn-hangzhou-d
VNodeId	string	k8s 虚拟节点 ID。	vn-***************
LinkIP	string	私网 IP	10..12
ChildVolumes	array<object>	数据盘列表。
	object	数据盘信息。
StorageType	string	存储类别	PL1
StorageCategory	string	存储类型	PolarFs
SizeGB	string	存储盘大小	8192
Name	string	磁盘名	jueming
MountPath	string	实际挂载路径	/tmp/CrowdStrike
PublicIp	string	公网 IP	101.101.101.101
CreationTime	string	创建时间	2020-08-14T05:58:42Z
LockMode	string	实例锁定模式，取值为 lock，实例自动过期或欠费。	Unlock
CreationTime	string	集群创建时间。	2020-08-14T05:58:42Z
PayType	string	付费类型。取值范围如下： Postpaid：按量付费。 Prepaid：预付费（包年包月）。	Postpaid
ExpireTime	string	集群到期时间。说明仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。	2020-11-14T16:00:00Z
Expired	boolean	是否集群已过期。取值范围如下： true false	false
ZoneIds	string	可用区 ID。	cn-hangzhou-i,cn-hangzhou-g
RunType	string	架构类型。可选： container： ai 容器 ainode：ai 节点。	container
KubeClusterId	string	ACK 集群 ID	xxxxxxxxxxxxxxxxxxxxxxx
DBVersion	string	集群版本，取值为: 1.0 2.0 3.0。	1.0
AiNodeType	string	节点类型。可选： vnode： ACK 纳管 container：可登录容器 maas：模型服务	vnode
Volumes	array<object>	数据盘列表
	object	数据盘数据
StorageType	string	存储类别	PolarFs
StorageCategory	string	存储类型	PL1
Name	string	磁盘名	jueming
SizeGB	string	存储大小	8192
MountPath	string	容器内挂载路径。	/var/run/secrets/kubernetes.io/serviceaccount
EndpointList	array<object>	实例的网络链接地址列表
	array<object>	实例的网络链接地址
NetInfoItems	array<object>	实例的网络信息列表
	object	实例的网络信息列表。
NetType	string	连接串网络类型，取值范围如下： Public：公网地址 Private：私网地址 Inner：私网地址（经典网络）	Public
ConnectionString	string	数据库连接地址。	pc-**********.rwlb.rds.aliyuncs.com
Port	string	端口号。	3306
ModelName	string	模型名称	Qwen3-Embedding-8B
MaxQPM	string	每分钟最大请求数	20
PublicIp	string	公网 IP 地址	8.xxx.xxx.xxx
KVCacheInstanceId	string	KVCache 实例 id	pkv-xxxxx
EcsSecurityGroupId	string	安全组 ID	sg-xxxxxx
ModelType	string	模型类型	custom
ApiKey	string	API 密钥	x********

示例

正常返回示例

JSON格式

{
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBClusterId": "pc-**************",
  "DBClusterStatus": "Running",
  "DBClusterDescription": "test",
  "RegionId": "cn-hangzhou",
  "ZoneId": "cn-hangzhou-d\t\n",
  "VPCId": "vpc-*******************",
  "VSwitchId": "vsw-*********************",
  "InternalIp": "10.*.*.72",
  "StorageType": "essdpl1",
  "DBNodes": [
    {
      "DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
      "CpuCores": "2",
      "MemorySize": "8192",
      "GPU": "2",
      "DBNodeId": "pi-****************",
      "DBNodeDescription": "test",
      "VSwitchId": "vsw-*********************",
      "VPCId": "vpc-*******************",
      "DBNodeStatus": "Running",
      "ZoneId": "cn-hangzhou-d\t\n",
      "VNodeId": "vn-***************",
      "LinkIP": "10.*.*12",
      "ChildVolumes": [
        {
          "StorageType": "PL1",
          "StorageCategory": "PolarFs",
          "SizeGB": "8192",
          "Name": "jueming",
          "MountPath": "/tmp/CrowdStrike"
        }
      ],
      "PublicIp": "101.101.101.101",
      "CreationTime": "2020-08-14T05:58:42Z"
    }
  ],
  "LockMode": "Unlock",
  "CreationTime": "2020-08-14T05:58:42Z",
  "PayType": "Postpaid",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "Expired": false,
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "RunType": "container",
  "KubeClusterId": "xxxxxxxxxxxxxxxxxxxxxxx",
  "DBVersion": "1.0",
  "AiNodeType": "vnode",
  "Volumes": [
    {
      "StorageType": "PolarFs",
      "StorageCategory": "PL1",
      "Name": "jueming",
      "SizeGB": "8192",
      "MountPath": "/var/run/secrets/kubernetes.io/serviceaccount"
    }
  ],
  "EndpointList": [
    {
      "NetInfoItems": [
        {
          "NetType": "Public",
          "ConnectionString": "pc-**********.rwlb.rds.aliyuncs.com",
          "Port": "3306"
        }
      ]
    }
  ],
  "ModelName": "\nQwen3-Embedding-8B",
  "MaxQPM": "20",
  "PublicIp": "8.xxx.xxx.xxx",
  "KVCacheInstanceId": "pkv-xxxxx",
  "EcsSecurityGroupId": "sg-xxxxxx",
  "ModelType": "custom",
  "ApiKey": "x********"
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

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