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

查看custom实例详情

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeAIDBClusterAttribute

get

*AICluster

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

无

请求参数

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

返回参数

名称	类型	描述	示例值
	object	Schema of Response
AiNodeType	string	节点类型。可选： vnode： ACK 纳管 container：可登录容器 maas：模型服务	vnode
ApiKey	string	API 密钥	x********
Command	string	模型服务当前使用的启动命令。	python -m vllm.entrypoints.openai.api_server
CreationTime	string	集群创建时间。时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。	2020-08-14T05:58:42Z
CurrentCapacity	integer	实例当前实测模型容量，抽象容量单位为 1000 等于一张 L20N 等效卡。	8000
CustomOssPath	string	实例当前使用的自定义模型 OSS 路径。	/my-model-bucket/models/qwen3
DBClusterDescription	string	集群描述，可模糊查询。	test
DBClusterId	string	集群 ID。	pc-**************
DBClusterStatus	string	集群状态，取值范围如下： Creating：创建中 Running：运行中 Deleting：释放中 DBNodeCreating：正在增加节点 DBNodeDeleting：正在删除节点 ClassChanging：正在变更节点规格 Deleted：已释放	Running
DBInstanceStatusDesc	string	数据库实例状态描述；ACTIVATION 表示运行中。	ACTIVATION
DBNodes	array<object>	节点信息详情。
	array<object>	节点信息详情。
ChildVolumes	array<object>	数据盘列表。
	object	数据盘信息。
MountPath	string	实际挂载路径	/tmp/CrowdStrike
Name	string	磁盘名	jueming
SizeGB	string	存储盘大小	8192
StorageCategory	string	存储类型	PolarFs
StorageType	string	存储类别	PL1
Command	string	该模型当前使用的启动命令；无记录时为空字符串。	python -m vllm.entrypoints.openai.api_server
CpuCores	string	节点 CPU 核数。	2
CreationTime	string	创建时间时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。	2020-08-14T05:58:42Z
DBNodeClass	string	集群规格	polar.pg.g8.8xlarge.gu30
DBNodeDescription	string	节点描述。	test
DBNodeId	string	节点 ID。	pi-****************
DBNodeStatus	string	节点状态，取值范围如下： Creating：创建中 Running：运行中 Deleting：删除中 Rebooting：重启中 DBNodeCreating：正在增加节点 DBNodeDeleting：正在删除节点 ClassChanging：正在变更节点规格 MinorVersionUpgrading：小版本升级中 Maintaining：实例维护中 Switching：切换中	Running
GPU	string	GPU 卡数。	2
LinkIP	string	私网 IP	10..12
LogIndex	string	Worker 节点日志索引。	worker-0
MemorySize	string	节点内存大小，单位：MB。	8192
ModelName	string	模型名称。	Qwen3-Embedding-8B
ModelSpaceName	string	模型所属空间名称。	my-model-space
PublicIp	string	公网 IP	101.101.101.101
SupportedApis	array<object>	支持的 API
	object
ApiName	string	数据库节点支持的 API 名称	Completions
GenerationMode	string	API 的生成模式。	stream
Path	string	支持的 API 路径	/v1/chat/completions
Protocol	string	支持的 API 协议类型	HTTP
VNodeId	string	k8s 虚拟节点 ID。	vn-***************
VPCId	string	专有网络 ID。	vpc-*******************
VSwitchId	string	虚拟交换机 ID。	vsw-*********************
ZoneId	string	可用区。	cn-hangzhou-d
DBVersion	string	集群版本，取值为: 1.0 2.0 3.0。	1.0
DedicatedHostModel	boolean	是否采用独占宿主机模式。
EcsSecurityGroupId	string	安全组 ID	sg-xxxxxx
EndpointList	array<object>	实例的网络链接地址列表
	array<object>	实例的网络链接地址
NetInfoItems	array<object>	实例的网络信息列表
	object	实例的网络信息列表。
ConnectionString	string	数据库连接地址。	pc-**********.rwlb.rds.aliyuncs.com
NetType	string	连接串网络类型，取值范围如下： Public：公网地址 Private：私网地址 Inner：私网地址（经典网络）	Public
Port	string	端口号。	3306
ExpireTime	string	集群到期时间。说明仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。	2020-11-14T16:00:00Z
Expired	boolean	是否集群已过期。取值范围如下： true false	false
GatewayId	string	AI 网关实例 ID。	pg-2ze24rr575j5b18cg
InferenceEngine	string	模型推理引擎。	sglang
InternalIp	string	内网 IP	10...72
KVCacheInstanceId	string	KVCache 实例 id	pkv-xxxxx
KubeClusterId	string	ACK 集群 ID	xxxxxxxxxxxxxxxxxxxxxxx
LockMode	string	实例锁定模式，取值为 lock，实例自动过期或欠费。	Unlock
MaxQPM	string	每分钟最大请求数	20
MaxTPM	string	每分钟允许的最大 Token 数。	10000
ModelName	string	模型名称	Qwen3-Embedding-8B
ModelSpaceName	string	模型所属空间名称。	my-model-space
ModelType	string	模型类型	custom
PayType	string	付费类型。取值范围如下： Postpaid：按量付费。 Prepaid：预付费（包年包月）。	Postpaid
PreviousCustomOssPath	string	上一次变更前的自定义模型 OSS 路径。	/my-model-bucket/models/qwen2
PublicIp	string	公网 IP 地址	8.xxx.xxx.xxx
RegionId	string	地域 ID。	cn-hangzhou
RequestId	string	Id of the request	EBEAA83D-1734-42E3-85E3-E25F6E******
RunType	string	架构类型。可选： container： ai 容器 ainode：ai 节点。	container
StorageType	string	企业版存储类型取值如下： PSL5 PSL4 标准版存储类型取值如下： ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	essdpl1
TimeSlicesInfo	object	按量售卖时间段配置。
TimeSlices	array<object>	按量售卖时间段列表。
	object
BeginTime	string	时间段开始时间，格式为 HH:mm。	08:00
EndTime	string	时间段结束时间，格式为 HH:mm。	18:00
TimeSlicesType	string	时间段配置的周期类型。	daily
VPCId	string	切换可用区支持指定的专有网络 ID。	vpc-*******************
VSwitchId	string	虚拟交换机 ID。说明如果已选择 VPCId，则 VSwitchId 必选。	vsw-*********************
VnodeKubernetesConfig	object	虚拟节点的 Kubernetes 配置。
Labels	array<object>	Kubernetes 节点标签列表。
	object
Key	string	节点标签键。	environment
Value	string	节点标签值。	production
Taints	array<object>	Kubernetes 节点污点列表。
	object
Effect	string	节点污点的调度效果。	NoSchedule
Key	string	节点污点键。	dedicated
Value	string	节点污点值。	groupName
Volumes	array<object>	数据盘列表
	object	数据盘数据
MountPath	string	容器内挂载路径。	/var/run/secrets/kubernetes.io/serviceaccount
Name	string	磁盘名	jueming
SizeGB	string	存储大小	8192
StorageCategory	string	存储类型	PL1
StorageType	string	存储类别	PolarFs
ZoneId	string	PolarDB 集群节点的可用区 ID。	cn-hangzhou-d
ZoneIds	string	可用区 ID。	cn-hangzhou-i,cn-hangzhou-g

示例

正常返回示例

JSON格式

{
  "AiNodeType": "vnode",
  "ApiKey": "x********",
  "Command": "python -m vllm.entrypoints.openai.api_server",
  "CreationTime": "2020-08-14T05:58:42Z",
  "CurrentCapacity": 8000,
  "CustomOssPath": "/my-model-bucket/models/qwen3",
  "DBClusterDescription": "test",
  "DBClusterId": "pc-**************",
  "DBClusterStatus": "Running",
  "DBInstanceStatusDesc": "ACTIVATION",
  "DBNodes": [
    {
      "ChildVolumes": [
        {
          "MountPath": "/tmp/CrowdStrike",
          "Name": "jueming",
          "SizeGB": "8192",
          "StorageCategory": "PolarFs",
          "StorageType": "PL1"
        }
      ],
      "Command": "python -m vllm.entrypoints.openai.api_server",
      "CpuCores": "2",
      "CreationTime": "2020-08-14T05:58:42Z",
      "DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
      "DBNodeDescription": "test",
      "DBNodeId": "pi-****************",
      "DBNodeStatus": "Running",
      "GPU": "2",
      "LinkIP": "10.*.*12",
      "LogIndex": "worker-0",
      "MemorySize": "8192",
      "ModelName": "Qwen3-Embedding-8B",
      "ModelSpaceName": "my-model-space",
      "PublicIp": "101.101.101.101",
      "SupportedApis": [
        {
          "ApiName": "Completions",
          "GenerationMode": "stream",
          "Path": "/v1/chat/completions",
          "Protocol": "HTTP"
        }
      ],
      "VNodeId": "vn-***************",
      "VPCId": "vpc-*******************",
      "VSwitchId": "vsw-*********************",
      "ZoneId": "cn-hangzhou-d\t\n"
    }
  ],
  "DBVersion": "1.0",
  "DedicatedHostModel": true,
  "EcsSecurityGroupId": "sg-xxxxxx",
  "EndpointList": [
    {
      "NetInfoItems": [
        {
          "ConnectionString": "pc-**********.rwlb.rds.aliyuncs.com",
          "NetType": "Public",
          "Port": "3306"
        }
      ]
    }
  ],
  "ExpireTime": "2020-11-14T16:00:00Z",
  "Expired": false,
  "GatewayId": "pg-2ze24rr575j5b18cg",
  "InferenceEngine": "sglang",
  "InternalIp": "10.*.*.72",
  "KVCacheInstanceId": "pkv-xxxxx",
  "KubeClusterId": "xxxxxxxxxxxxxxxxxxxxxxx",
  "LockMode": "Unlock",
  "MaxQPM": "20",
  "MaxTPM": "10000",
  "ModelName": "\nQwen3-Embedding-8B",
  "ModelSpaceName": "my-model-space",
  "ModelType": "custom",
  "PayType": "Postpaid",
  "PreviousCustomOssPath": "/my-model-bucket/models/qwen2",
  "PublicIp": "8.xxx.xxx.xxx",
  "RegionId": "cn-hangzhou",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "RunType": "container",
  "StorageType": "essdpl1",
  "TimeSlicesInfo": {
    "TimeSlices": [
      {
        "BeginTime": "08:00",
        "EndTime": "18:00"
      }
    ]
  },
  "TimeSlicesType": "daily",
  "VPCId": "vpc-*******************",
  "VSwitchId": "vsw-*********************",
  "VnodeKubernetesConfig": {
    "Labels": [
      {
        "Key": "environment",
        "Value": "production"
      }
    ],
    "Taints": [
      {
        "Effect": "NoSchedule",
        "Key": "dedicated",
        "Value": "groupName"
      }
    ]
  },
  "Volumes": [
    {
      "MountPath": "/var/run/secrets/kubernetes.io/serviceaccount",
      "Name": "jueming",
      "SizeGB": "8192",
      "StorageCategory": "PL1",
      "StorageType": "PolarFs"
    }
  ],
  "ZoneId": "cn-hangzhou-d\t\n",
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g"
}

错误码

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。

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

变更历史

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