DescribeDBClusterAttribute - PolarDB - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries information about a PolarDB cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:DescribeDBClusterAttribute	get	*DBCluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	Cluster ID. Note You can view detailed information about all clusters under your account, including the cluster ID, through the DescribeDBClusters interface.	pc-*****************
DescribeType	string	No	Whether to obtain information about AI-related nodes.	AI

Response parameters

Parameter	Type	Description	Example
	object
DeletionLock	integer	Lock status for cluster deletion, with values as follows: 0: Unlocked, cluster can be deleted. 1: Locked, cluster cannot be deleted.	0
Category	string	Product Series, with values as follows: Normal: Cluster Edition Basic: Single Node Archive: High Compression Engine (X-Engine) NormalMultimaster: Multi-Master Cluster Edition SENormal: Standard Edition Note PolarDB PostgreSQL version 11 does not support single-node. PolarDB MySQL versions 8.0 and 5.7, and PolarDB PostgreSQL version 14 support the Standard Edition. PolarDB MySQL version 8.0 supports High Compression Engine (X-Engine) and Multi-Master Cluster Edition.	Normal
ResourceGroupId	string	Resource group ID.	rg-***************
DataLevel1BackupChainSize	long	Total size of Level 1 backups (snapshots), in bytes.	74448896
DBClusterId	string	Cluster ID.	pc-*****************
DBType	string	Database engine type.	MySQL
DBClusterNetworkType	string	Network type of the cluster.	VPC
IsLatestVersion	boolean	Indicates whether it is the latest kernel version. Values are as follows: true: Yes false: No	false
HasCompleteStandbyRes	boolean	Whether to replenish resources for the new primary after cross-AZ switch. Values are as follows: true: Yes false: No	false
HotStandbyCluster	string	Whether to enable storage hot backup cluster (and Standby compute nodes). Values are as follows: StandbyClusterON: Enable storage hot backup/Enable storage hot backup and Standby compute nodes. StandbyClusterOFF: Disable storage hot backup/Disable storage hot backup and Standby compute nodes.	StandbyClusterON
DataSyncMode	string	Data replication relationship mode. Values are as follows: AsyncSync: Asynchronous SemiSync: Semi-synchronous	AsyncSync
StandbyHAMode	string	Cross-AZ disaster recovery mode. Values are as follows: ON: Enable cross-AZ disaster recovery mode. OFF: Disable cross-AZ disaster recovery mode. 0: Customer drill mode.	OFF
CompressStorageMode	string	Whether storage compression is enabled. Values are as follows: ON: Enabled OFF: Disabled	ON
StorageMax	long	The maximum storage capacity of the current cluster specification, in bytes.	10995116277760
DBVersion	string	Database engine version.	8.0
DBNodes	array<object>	The information about the nodes.
DBNode	object
CreationTime	string	Node creation time.	2020-03-23T21:35:43Z
FailoverPriority	integer	Failover priority. Each node has a failover priority, determining the likelihood of being elected as the primary node during a failover. A higher value indicates a higher priority. Range: 1 to 15.	1
MaxIOPS	integer	Maximum number of I/O requests, that is, IOPS.	32000
DBNodeClass	string	Node specification.	polar.mysql.x4.large
CpuCores	string	Number of CPU cores for the node.	2
MemorySize	string	Node memory size, in MB.	8192
DBNodeRole	string	Node role, with possible values as follows: Writer: Primary node. Reader: Read-only node.	Reader
ZoneId	string	Availability zone ID.	cn-hangzhou-i
MaxConnections	integer	Maximum concurrent connections of the cluster.	8000
DBNodeStatus	string	Node status, with possible values as follows: Creating: Creating Running: Running Deleting: Deleting Rebooting: Rebooting DBNodeCreating: Adding node DBNodeDeleting: Removing node ClassChanging: Modifying node specification NetAddressCreating: Creating network connection NetAddressDeleting: Deleting network connection NetAddressModifying: Modifying network connection MinorVersionUpgrading: Upgrading minor version Maintaining: Instance maintenance Switching: Switching	Running
DBNodeId	string	Node ID.	pi-****************
ImciSwitch	string	Whether columnar index is enabled. Possible values are: ON: Enabled OFF: Disabled	ON
HotReplicaMode	string	Whether hot standby is enabled. Possible values are: ON: Enabled OFF: Disabled	ON
AddedCpuCores	string	Number of CPU cores for second-level elastic scaling.	6
MasterId	string	Primary node ID of the multi-master architecture cluster edition.	pi-bp18z52akld3*****
SccMode	string	Whether the node has the global consistency (high-performance mode) feature enabled. Possible values are: ON: Enabled OFF: Disabled	ON
ServerWeight	string	Routing weight. Range: 1~100. Default is 1.	1
ServerlessType	string	Serverless type. Possible values include: AgileServerless: Agile SteadyServerless: Steady Note This parameter is only supported by Serverless clusters.	AgileServerless
SubCluster	string	Identifies whether the node is in the primary or standby availability zone, primarily used in resource mirroring scenarios. Values include: Primary: Primary Availability Zone Standby: Standby Availability Zone	Primary
RemoteMemorySize	string	Remote memory size, in MB.	3072
Orca	string	Orca feature, valid values are: on: enabled off: disabled	off
MirrorInsName	string	The name of the hot standby compute node corresponding to the node when the hot standby storage and compute clusters feature is enabled.	pi-bp18z52mirror*****
ZoneIds	string	Availability Zone IDs.	cn-hangzhou-i,cn-hangzhou-g
MaintainTime	string	The maintenance window for the cluster, formatted as `HH:mmZ-HH:mmZ` (UTC time). For example, `16:00Z-17:00Z` indicates that routine maintenance can be performed from 0:00 to 1:00 (UTC+08:00).	18:00Z-19:00Z
Engine	string	Cluster engine.	POLARDB
Tags	array<object>	Details of tags.
Tag	object
Key	string	Tag key.	test
Value	string	Tag value.	MySQL
RequestId	string	Request ID.	074467EF-86B9-4C23-ACBF-E9B81A******
VPCId	string	VPC ID.	vpc-*******************
DBClusterStatus	string	Cluster status. For the full list of values, refer to Cluster Status Table.	Running
VSwitchId	string	VSwitch ID.	vsw-*********************
DBClusterDescription	string	Cluster description.	test
Expired	string	Whether the cluster has expired. Note This parameter is only supported for clusters with Prepaid (Subscription) payment methods.	false
PayType	string	Payment type. Possible values are: Postpaid: Pay-As-You-Go Prepaid: Prepaid (Subscription).	Prepaid
StoragePayType	string	Storage billing type. Valid values are as follows: Postpaid: Pay-as-you-go (by capacity). Prepaid: Subscription (by space).	Prepaid
LockMode	string	Lock mode. Possible values are as follows: Unlock: Unlocked. ManualLock: Manually triggered lock. LockByExpiration: Automatic cluster lock upon expiration.	Unlock
StorageUsed	long	Amount of used storage space, in bytes.	3012558848
CompressStorageUsed	long	Compressed storage data size. Note This parameter is supported only when the cluster's storage compression feature is enabled.	15529410560
StorageSpace	long	Storage space for pay-by-space (subscription) billing. Unit: Byte.	50
DBVersionStatus	string	The status of the minor version. Valid values: Stable: The minor version is stable. Old: The minor version is outdated. We recommend that you update it to the latest version. HighRisk: The minor version has critical defects. We recommend that you immediately update it to the latest version. Beta: The minor version is a Beta version. Note For information about how to update the minor version, see Minor version update.	Stable
CreationTime	string	Cluster creation time.	2020-08-14T05:58:42Z
SQLSize	long	Storage amount of SQL, in bytes. If the value is -1, it indicates no data.	0
InodeTotal	long	Maximum number of inodes in the file system.	6,291,456
InodeUsed	long	Current inode usage.	4,194,304
BlktagTotal	long	Maximum number of blktags in the file system.	7,864,320
BlktagUsed	long	Current blktag usage.	5,242,880
RegionId	string	Region ID.	cn-hangzhou
ExpireTime	string	Cluster expiration time. Note Only clusters with Prepaid (subscription) payment methods return specific parameter values; Postpaid (pay-as-you-go) clusters return empty values.	2020-11-14T16:00:00Z
SubCategory	string	Specification type of compute nodes, with possible values as follows: Exclusive: Dedicated specification General: General-purpose specification Note This parameter is supported only for PolarDB MySQL Edition with the product series set to Cluster Edition.	Exclusive
IsProxyLatestVersion	boolean	Indicates whether it is the latest version of the database proxy, with possible values as follows: true: Yes false: No	false
StorageType	string	Storage type, with a fixed value of HighPerformance.	HighPerformance
ServerlessType	string	Serverless type. Valid values are as follows: AgileServerless: Agile - SteadyServerless: Stable	AgileServerless
StrictConsistency	string	Indicates whether multi-AZ data strong consistency is enabled for the cluster. The value ranges are as follows: ON: Indicates that multi-AZ data strong consistency is enabled, applicable to the Standard 3AZ scenario. OFF: Indicates that multi-AZ data strong consistency is not enabled.	ON
ProxyCpuCores	string	Number of CPU cores for the database proxy.	4
ProxyStandardCpuCores	string	Standard configuration CPU cores for the database proxy.	2
ProxyType	string	Database proxy types, with the following values: Exclusive: Enterprise Exclusive Edition General: Enterprise General Purpose Edition	Exclusive
ProxyStatus	string	Status of the database proxy. Possible values include: Creating: Creating Running: Running Deleting: Releasing Rebooting: Restarting DBNodeCreating: Adding nodes DBNodeDeleting: Deleting nodes ClassChanging: Changing node specifications NetAddressCreating: Creating network connections NetAddressDeleting: Deleting network connections NetAddressModifying: Modifying network connections Deleted: Released	Running
ProxyServerlessType	string	Serverless type for the database proxy. Currently, the value is fixed to AgileServerless.	AgileServerless
Architecture	string	CPU architecture. Available options are: X86 ARM	X86
AiType	string	Types of AI nodes. Values include: SearchNode: Search node. DLNode: AI node.	DLNode
ProvisionedIops	string	Describes the preconfigured read and write IOPS for ESSD AutoPL cloud disks. Possible values: 0 to min{50,000, 1000capacity - baseline performance}. Baseline performance = min{1,800 + 50capacity, 50000}. Note: This parameter is supported only when StorageType is ESSDAUTOPL.	2500
AiCreatingTime	string	Start time for free AI activation	2024-03-13T01:20:28Z
SupportInstantSwitchWithImci	string	Indicates whether queries based on In-Memory Column Indexes (IMCIs) are supported during and after a failover with hot replica.	ON
Orca	string	Orca function with possible values as follows: on: Enabled off: Disabled	ON
SourceDBCluster	string	Source cluster ID. Note Clusters restored from backup sets or specific points in time after June 1, 2024, support this parameter.	pc-pz51ziv48317b2880
RestoreType	string	Cluster recovery method, with possible values: RestoreByTime: Restore from a time point based on primary backup. * RestoreByBackupSet: Restore from a backup set based on primary backup. * RestoreByTimeOss: Restore from a time point based on secondary backup. * RestoreByBackupSetOss: Restore from a backup set based on secondary backup. * CloneFromSourceCluster: Clone from the source cluster. Note This parameter is only supported for clusters restored from a backup set or time point after June 1, 2024.	RestoreByTime
RestoreDataPoint	string	If RestoreType is RestoreByTime or RestoreByTimeOss, this value represents the recovery time point. If RestoreType is RestoreByBackupSet or RestoreByBackupSetOss, this value indicates the ID of the backup set on which the recovery is based. Note Only clusters restored from a backup set or time point after June 1, 2024, support this parameter.	2179639137
SourceRegionId	string	The region ID of the source cluster. Note This parameter is returned only if the source cluster ID exists.	cn-beijing
ImciAutoIndex	string	Indicates whether the automatic IMCI-based query acceleration feature is enabled. Valid values: `ON`: enabled `OFF`: disabled	OFF

description

Examples

Sample success responses

JSONformat

{
  "DeletionLock": 0,
  "Category": "Normal",
  "ResourceGroupId": "rg-***************",
  "DataLevel1BackupChainSize": 74448896,
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL",
  "DBClusterNetworkType": "VPC",
  "IsLatestVersion": false,
  "HasCompleteStandbyRes": false,
  "HotStandbyCluster": "StandbyClusterON",
  "DataSyncMode": "AsyncSync",
  "StandbyHAMode": "OFF",
  "CompressStorageMode": "ON",
  "StorageMax": 10995116277760,
  "DBVersion": "8.0",
  "DBNodes": [
    {
      "CreationTime": "2020-03-23T21:35:43Z",
      "FailoverPriority": 1,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "CpuCores": "2",
      "MemorySize": "8192",
      "DBNodeRole": "Reader",
      "ZoneId": "cn-hangzhou-i",
      "MaxConnections": 8000,
      "DBNodeStatus": "Running",
      "DBNodeId": "pi-****************",
      "ImciSwitch": "ON",
      "HotReplicaMode": "ON",
      "AddedCpuCores": "6",
      "MasterId": "pi-bp18z52akld3*****",
      "SccMode": "ON",
      "ServerWeight": "1",
      "ServerlessType": "AgileServerless",
      "SubCluster": "Primary",
      "RemoteMemorySize": "3072",
      "Orca": "off",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "MultiMasterLocalStandby": "",
      "MultiMasterPrimaryNode": "",
      "DBNodeDescription": ""
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Key": "test",
      "Value": "MySQL"
    }
  ],
  "RequestId": "074467EF-86B9-4C23-ACBF-E9B81A******",
  "VPCId": "vpc-*******************",
  "DBClusterStatus": "Running",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "StorageSpace": 50,
  "DBVersionStatus": "Stable",
  "CreationTime": "2020-08-14T05:58:42Z",
  "SQLSize": 0,
  "InodeTotal": 0,
  "InodeUsed": 0,
  "BlktagTotal": 0,
  "BlktagUsed": 0,
  "RegionId": "cn-hangzhou",
  "ExpireTime": "2020-11-14T16:00:00Z",
  "SubCategory": "Exclusive",
  "IsProxyLatestVersion": false,
  "StorageType": "HighPerformance",
  "ServerlessType": "AgileServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "AgileServerless",
  "Architecture": "X86",
  "AiType": "DLNode",
  "ProvisionedIops": "2500",
  "AiCreatingTime": "2024-03-13T01:20:28Z",
  "SupportInstantSwitchWithImci": "ON",
  "Orca": "ON",
  "SourceDBCluster": "pc-pz51ziv48317b2880",
  "RestoreType": "RestoreByTime",
  "RestoreDataPoint": "2179639137",
  "SourceRegionId": "cn-beijing",
  "ImciAutoIndex": "OFF",
  "BurstingEnabled": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.	-
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-20	The Error code has changed. The response structure of the API has changed	View Change Details
2024-07-30	The Error code has changed. The response structure of the API has changed	View Change Details
2024-06-06	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-18	The Error code has changed. The response structure of the API has changed	View Change Details
2024-02-22	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-26	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-07	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-06	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-26	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-12	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-12	The Error code has changed. The response structure of the API has changed	View Change Details
2023-08-31	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-06	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-06-12	The Error code has changed	View Change Details
2023-04-11	The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-28	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details
2022-11-02	The Error code has changed. The response structure of the API has changed	View Change Details
2022-06-02	The Error code has changed. The response structure of the API has changed	View Change Details
2021-12-07	The Error code has changed. The response structure of the API has changed	View Change Details
2021-12-07	The Error code has changed. The response structure of the API has changed	View Change Details