All Products
Search

This Product

    PolarDB:DescribeDBClusterAttribute

    Document Center

    PolarDB:DescribeDBClusterAttribute

    Last Updated:Jul 10, 2025

    Queries information about a PolarDB cluster.

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

    integer

    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

    integer

    The maximum storage capacity of the current cluster specification, in bytes.

    10995116277760
    DBVersion

    string

    Database engine version.

    8.0
    DBNodes

    array

    The information about the nodes.

    object

    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
    SubGroupDescription

    string

    AddedCpuCores

    string

    Number of CPU cores for second-level elastic scaling.

    6
    Orca

    string

    Orca feature, valid values are:

    • on: enabled

    • off: disabled

    off
    DBNodeRole

    string

    Node role, with possible values as follows:

    • Writer: Primary node.

    • Reader: Read-only node.

    Reader
    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
    ImciSwitch

    string

    Whether columnar index is enabled. Possible values are:

    • ON: Enabled

    • OFF: Disabled

    ON
    DBNodeId

    string

    Node ID.

    pi-****************
    RemoteMemorySize

    string

    Remote memory size, in MB.

    3072
    MultiMasterLocalStandby

    string

    MultiMasterPrimaryNode

    string

    SccMode

    string

    Whether the node has the global consistency (high-performance mode) feature enabled. Possible values are:

    • ON: Enabled

    • OFF: Disabled

    ON
    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
    ServerWeight

    string

    Routing weight. Range: 1~100. Default is 1.

    1
    DBNodeDescription

    string

    test
    MemorySize

    string

    Node memory size, in MB.

    8192
    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*****
    ZoneId

    string

    Availability zone ID.

    cn-hangzhou-i
    MaxConnections

    integer

    Maximum concurrent connections of the cluster.

    8000
    MaxIOPS

    integer

    Maximum number of I/O requests, that is, IOPS.

    32000
    DBNodeClass

    string

    Node specification.

    polar.mysql.x4.large
    ServerlessType

    string

    Serverless type. Possible values include:

    • AgileServerless: Agile

    • SteadyServerless: Steady

    Note

    This parameter is only supported by Serverless clusters.

    AgileServerless
    CreationTime

    string

    Node creation time.

    2020-03-23T21:35:43Z
    CpuCores

    string

    Number of CPU cores for the node.

    2
    MasterId

    string

    Primary node ID of the multi-master architecture cluster edition.

    pi-bp18z52akld3*****
    HotReplicaMode

    string

    Whether hot standby is enabled. Possible values are:

    • ON: Enabled

    • OFF: Disabled

    ON
    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

    Details of tags.

    object

    Value

    string

    Tag value.

    MySQL
    Key

    string

    Tag key.

    test
    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

    integer

    Amount of used storage space, in bytes.

    3012558848
    CompressStorageUsed

    integer

    Compressed storage data size.

    Note

    This parameter is supported only when the cluster's storage compression feature is enabled.

    15529410560
    StorageSpace

    integer

    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

    integer

    Storage amount of SQL, in bytes. If the value is -1, it indicates no data.

    0
    InodeTotal

    integer

    Maximum number of inodes in the file system.

    6,291,456
    InodeUsed

    integer

    Current inode usage.

    4,194,304
    BlktagTotal

    integer

    Maximum number of blktags in the file system.

    7,864,320
    BlktagUsed

    integer

    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 + 50
    capacity, 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
    AutoUpgradeMinorVersion

    string

    The minor version upgrade method.

    • Auto

    • Manual

    Manual
    BurstingEnabled

    string

    false
    RowCompression

    string

    ImperceptibleSwitch

    string

    Indicates whether failover with hot replica is enabled. Valid values:

    • true

    • false (default)

    Examples

    Success response

    JSON format

    {
  "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": [
    {
      "DBNodeStatus": "Running",
      "SubGroupDescription": "",
      "AddedCpuCores": "6",
      "Orca": "off",
      "DBNodeRole": "Reader",
      "SubCluster": "Primary",
      "ImciSwitch": "ON",
      "DBNodeId": "pi-****************",
      "RemoteMemorySize": "3072",
      "MultiMasterLocalStandby": "",
      "MultiMasterPrimaryNode": "",
      "SccMode": "ON",
      "FailoverPriority": 1,
      "ServerWeight": "1",
      "DBNodeDescription": "test",
      "MemorySize": "8192",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "ZoneId": "cn-hangzhou-i",
      "MaxConnections": 8000,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "ServerlessType": "AgileServerless",
      "CreationTime": "2020-03-23T21:35:43Z",
      "CpuCores": "2",
      "MasterId": "pi-bp18z52akld3*****",
      "HotReplicaMode": "ON"
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Value": "MySQL",
      "Key": "test"
    }
  ],
  "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",
  "AutoUpgradeMinorVersion": "Manual",
  "BurstingEnabled": "false",
  "RowCompression": "",
  "ImperceptibleSwitch": ""
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.