DescribeAIDBClusterAttribute-阿里云帮助中心

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
RequestId	string	Id of the request	EBEAA83D-1734-42E3-85E3-E25F6E******
DBClusterId	string	The cluster ID.	pc-**************
DBClusterStatus	string	The cluster status. Valid values: Creating: being created Running: running Deleting: being released DBNodeCreating: adding a node DBNodeDeleting: deleting a node ClassChanging: changing node specifications Deleted: released.	Running
DBClusterDescription	string	The cluster description. Fuzzy match is supported.	test
RegionId	string	The region ID.	cn-hangzhou
ZoneId	string	The zone ID of the PolarDB cluster node.	cn-hangzhou-d
VPCId	string	The VPC ID specified for the zone switchover.	vpc-*******************
VSwitchId	string	The vSwitch ID. Note If VPCId is specified, VSwitchId is required.	vsw-*********************
InternalIp	string	The internal IP address.	10...72
StorageType	string	Valid values for PolarDB Enterprise Edition: PSL5 PSL4 Valid values for PolarDB for MySQL Standard Edition: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL.	essdpl1
DBNodes	array<object>	The node details.
	array<object>	The node details.
DBNodeClass	string	The cluster specifications.	polar.pg.g8.8xlarge.gu30
CpuCores	string	The number of CPU cores of the node.	2
MemorySize	string	The memory size of the node. Unit: MB.	8192
GPU	string	The number of GPU cards.	2
DBNodeId	string	The node ID.	pi-****************
DBNodeDescription	string	The node description.	test
VSwitchId	string	The vSwitch ID.	vsw-*********************
VPCId	string	The VPC ID.	vpc-*******************
DBNodeStatus	string	The node status. Valid values: Creating: being created Running: running Deleting: being deleted Rebooting: restarting DBNodeCreating: adding a node DBNodeDeleting: deleting a node ClassChanging: changing node specifications MinorVersionUpgrading: upgrading the minor engine version Maintaining: under maintenance Switching: switching.	Running
ZoneId	string	The zone ID.	cn-hangzhou-d
VNodeId	string	The Kubernetes virtual node ID.	vn-***************
LinkIP	string	The private IP address.	10..12
ChildVolumes	array<object>	The list of data cloud disks.
	object	The data cloud disk information.
StorageType	string	The storage type.	PL1
StorageCategory	string	The storage category.	PolarFs
SizeGB	string	The size of the data disk in GB.	8192
Name	string	The disk name.	jueming
MountPath	string	The mount path.	/tmp/CrowdStrike
PublicIp	string	The public IP address.	101.101.101.101
CreationTime	string	The creation time.	2020-08-14T05:58:42Z
LockMode	string	The instance lock mode. The value lock indicates that the instance is automatically locked due to expiration or overdue payment.	Unlock
CreationTime	string	The cluster creation time.	2020-08-14T05:58:42Z
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
ExpireTime	string	The cluster expiration time. Note This parameter is returned only for Prepaid (subscription) clusters. An empty value is returned for Postpaid (pay-as-you-go) clusters.	2020-11-14T16:00:00Z
Expired	boolean	Indicates whether the cluster has expired. Valid values: true false.	false
ZoneIds	string	The zone ID.	cn-hangzhou-i,cn-hangzhou-g
RunType	string	The architecture type. Valid values: container: AI container ainode: AI node.	container
KubeClusterId	string	The ACK cluster ID.	xxxxxxxxxxxxxxxxxxxxxxx
DBVersion	string	The cluster version. Valid values: 1.0 2.0 3.0.	1.0
AiNodeType	string	The node type. Valid values: vnode: managed by ACK container: logon-enabled container maas: model service.	vnode
Volumes	array<object>	The list of data cloud disks.
	object	The data cloud disk information.
StorageType	string	The storage class.	PolarFs
StorageCategory	string	The storage type.	PL1
Name	string	The cloud disk name.	jueming
SizeGB	string	The storage size.	8192
MountPath	string	The mount path in the container.	/var/run/secrets/kubernetes.io/serviceaccount
EndpointList	array<object>	The list of network connection addresses of the instance.
	array<object>	The network connection address of the instance.
NetInfoItems	array<object>	The list of network information of the instance.
	object	The network information of the instance.
NetType	string	The network type of the endpoint. Valid values: Public: A public endpoint. Private: A private endpoint. Inner: A private endpoint in a classic network.	Public
ConnectionString	string	The database endpoint.	pc-**********.rwlb.rds.aliyuncs.com
Port	string	The port number.	3306
ModelName	string	The model name.	Qwen3-Embedding-8B
GatewayId	string
MaxQPM	string	The maximum number of requests per minute.	20
PublicIp	string	The public IP address.	8.xxx.xxx.xxx
KVCacheInstanceId	string	The KVCache instance ID.	pkv-xxxxx
EcsSecurityGroupId	string	The security group ID.	sg-xxxxxx
ModelType	string	The model type.	custom
ApiKey	string	The API key.	x********

Examples

Success response

JSON format

{
  "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",
  "GatewayId": "",
  "MaxQPM": "20",
  "PublicIp": "8.xxx.xxx.xxx",
  "KVCacheInstanceId": "pkv-xxxxx",
  "EcsSecurityGroupId": "sg-xxxxxx",
  "ModelType": "custom",
  "ApiKey": "x********"
}

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.