Query AI DB Cluster Attributes via DescribeAIDBClusterAttribute - PolarDB - Alibaba Cloud - PolarDB

Queries the details of a custom instance.

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:DescribeAIDBClusterAttribute

get

*AICluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-****************

Response elements

Element	Type	Description	Example
	object	Schema of Response
AiNodeType	string	The node type. Valid values: vnode: managed by ACK container: loginable container maas: model service	vnode
ApiKey	string	The API key.	x********
CreationTime	string	The time when the cluster was created. The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2020-08-14T05:58:42Z
CustomOssPath	string	The custom model OSS path currently used by the instance.	/my-model-bucket/models/qwen3
DBClusterDescription	string	The cluster description. Fuzzy match is supported.	test
DBClusterId	string	The cluster ID.	pc-**************
DBClusterStatus	string	The cluster status. Valid values: Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being released. DBNodeCreating: A node is being added. DBNodeDeleting: A node is being deleted. ClassChanging: The node specifications are being changed. Deleted: The cluster has been released.	Running
DBInstanceStatusDesc	string
DBNodes	array<object>	The details of the nodes.
	array<object>	The details of the nodes.
ChildVolumes	array<object>	The list of data cloud disks.
	object	The data cloud disk information.
MountPath	string	The actual mount path.	/tmp/CrowdStrike
Name	string	The disk name.	jueming
SizeGB	string	The storage disk size.	8192
StorageCategory	string	The storage type.	PolarFs
StorageType	string	The storage category.	PL1
CpuCores	string	The number of CPU cores of the node.	2
CreationTime	string	The creation time. The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2020-08-14T05:58:42Z
DBNodeClass	string	The cluster specifications.	polar.pg.g8.8xlarge.gu30
DBNodeDescription	string	The node description.	test
DBNodeId	string	The node ID.	pi-****************
DBNodeStatus	string	The node status. Valid values: Creating: The node is being created. Running: The node is running. Deleting: The node is being deleted. Rebooting: The node is being restarted. DBNodeCreating: A node is being added. DBNodeDeleting: A node is being deleted. ClassChanging: The node specifications are being changed. MinorVersionUpgrading: A minor engine version update is in progress. Maintaining: The instance is under maintenance. Switching: A switchover is in progress.	Running
GPU	string	The number of GPU cards.	2
LinkIP	string	The private IP address.	10..12
MemorySize	string	The memory size of the node. Unit: MB.	8192
ModelName	string
PublicIp	string	The public IP address.	101.101.101.101
SupportedApis	array<object>	The supported APIs.
	object
ApiName	string	The API name supported by the database node.
GenerationMode	string
Path	string	The supported API path.
Protocol	string	The supported API protocol type.
VNodeId	string	The Kubernetes virtual node ID.	vn-***************
VPCId	string	The VPC ID.	vpc-*******************
VSwitchId	string	The vSwitch ID.	vsw-*********************
ZoneId	string	The zone ID.	cn-hangzhou-d
DBVersion	string	The cluster version. Valid values: 1.0 2.0 3.0	1.0
DedicatedHostModel	boolean
EcsSecurityGroupId	string	The security group ID.	sg-xxxxxx
EndpointList	array<object>	The list of network endpoints of the instance.
	array<object>	The network endpoint of the instance.
NetInfoItems	array<object>	The list of network information of the instance.
	object	The network information of the instance.
ConnectionString	string	The database endpoint.	pc-**********.rwlb.rds.aliyuncs.com
NetType	string	The network type of the endpoint. Valid values: Public: public endpoint Private: private endpoint Inner: private endpoint (classic network)	Public
Port	string	The port number.	3306
ExpireTime	string	The expiration time of the cluster. Note Only clusters with the billing method of Prepaid (subscription) return a specific value. Postpaid (pay-as-you-go) clusters return an empty value. The time is in the ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).	2020-11-14T16:00:00Z
Expired	boolean	Indicates whether the cluster has expired. Valid values: true false	false
GatewayId	string
InferenceEngine	string
InternalIp	string	The internal IP address.	10...72
KVCacheInstanceId	string	The KVCache instance ID.	pkv-xxxxx
KubeClusterId	string	The ACK cluster ID.	xxxxxxxxxxxxxxxxxxxxxxx
LockMode	string	The lock mode of the instance. The value is lock, which indicates that the instance is automatically expired or has an overdue payment.	Unlock
MaxQPM	string	The maximum number of requests per minute.	20
MaxTPM	string
ModelName	string	The model name.	Qwen3-Embedding-8B
ModelSpaceName	string
ModelType	string	The model type.	custom
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
PreviousCustomOssPath	string	The custom model OSS path before the last change.	/my-model-bucket/models/qwen2
PublicIp	string	The public IP address.	8.xxx.xxx.xxx
RegionId	string	The region ID.	cn-hangzhou
RequestId	string	Id of the request	EBEAA83D-1734-42E3-85E3-E25F6E******
RunType	string	The architecture type. Valid values: container: AI container ainode: AI node	container
StorageType	string	Valid values for Enterprise Edition storage type: PSL5 PSL4 Valid values for Standard Edition storage type: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	essdpl1
TimeSlicesInfo	object
TimeSlices	array<object>
	object
BeginTime	string
EndTime	string
TimeSlicesType	string
VPCId	string	The VPC ID that can be specified for cross-zone switchover.	vpc-*******************
VSwitchId	string	The vSwitch ID. Note If VPCId is specified, VSwitchId is required.	vsw-*********************
VnodeKubernetesConfig	object
Labels	array<object>
	object
Key	string
Value	string
Taints	array<object>
	object
Effect	string
Key	string
Value	string
Volumes	array<object>	The list of data cloud disks.
	object	The data cloud disk information.
MountPath	string	The mount path inside the container.	/var/run/secrets/kubernetes.io/serviceaccount
Name	string	The disk name.	jueming
SizeGB	string	The storage size.	8192
StorageCategory	string	The storage type.	PL1
StorageType	string	The storage category.	PolarFs
ZoneId	string	The zone ID of the PolarDB cluster node.	cn-hangzhou-d
ZoneIds	string	The zone ID.	cn-hangzhou-i,cn-hangzhou-g

Examples

Success response

JSON format

{
  "AiNodeType": "vnode",
  "ApiKey": "x********",
  "CreationTime": "2020-08-14T05:58:42Z",
  "CustomOssPath": "/my-model-bucket/models/qwen3",
  "DBClusterDescription": "test",
  "DBClusterId": "pc-**************",
  "DBClusterStatus": "Running",
  "DBInstanceStatusDesc": "",
  "DBNodes": [
    {
      "ChildVolumes": [
        {
          "MountPath": "/tmp/CrowdStrike",
          "Name": "jueming",
          "SizeGB": "8192",
          "StorageCategory": "PolarFs",
          "StorageType": "PL1"
        }
      ],
      "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",
      "MemorySize": "8192",
      "ModelName": "",
      "PublicIp": "101.101.101.101",
      "SupportedApis": [
        {
          "ApiName": "",
          "GenerationMode": "",
          "Path": "",
          "Protocol": ""
        }
      ],
      "VNodeId": "vn-***************",
      "VPCId": "vpc-*******************",
      "VSwitchId": "vsw-*********************",
      "ZoneId": "cn-hangzhou-d\t\n"
    }
  ],
  "DBVersion": "1.0",
  "DedicatedHostModel": false,
  "EcsSecurityGroupId": "sg-xxxxxx",
  "EndpointList": [
    {
      "NetInfoItems": [
        {
          "ConnectionString": "pc-**********.rwlb.rds.aliyuncs.com",
          "NetType": "Public",
          "Port": "3306"
        }
      ]
    }
  ],
  "ExpireTime": "2020-11-14T16:00:00Z",
  "Expired": false,
  "GatewayId": "",
  "InferenceEngine": "",
  "InternalIp": "10.*.*.72",
  "KVCacheInstanceId": "pkv-xxxxx",
  "KubeClusterId": "xxxxxxxxxxxxxxxxxxxxxxx",
  "LockMode": "Unlock",
  "MaxQPM": "20",
  "MaxTPM": "",
  "ModelName": "\nQwen3-Embedding-8B",
  "ModelSpaceName": "",
  "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": "",
        "EndTime": ""
      }
    ]
  },
  "TimeSlicesType": "",
  "VPCId": "vpc-*******************",
  "VSwitchId": "vsw-*********************",
  "VnodeKubernetesConfig": {
    "Labels": [
      {
        "Key": "",
        "Value": ""
      }
    ],
    "Taints": [
      {
        "Effect": "",
        "Key": "",
        "Value": ""
      }
    ]
  },
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.