All Products
Search

This Product

    PolarDB:DescribeDBClusterAttribute

    Document Center

    PolarDB:DescribeDBClusterAttribute

    Last Updated:Jul 14, 2026

    Queries the attribute information of a 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 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:DescribeDBClusterAttribute

    get

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    Note

    You can call the DescribeDBClusters operation to query the details of all clusters under your account, including cluster IDs.

    pc-*****************
    DescribeType

    string

    No

    Specifies whether to retrieve AI-related node information.

    AI

    Response elements

    Element

    Type

    Description

    Example

    object

    DeletionLock

    integer

    The lock status for cluster deletion. Valid values:

    • 0: Unlocked. The cluster can be deleted.

    • 1: Locked. The cluster cannot be deleted.

    0
    Category

    string

    The edition of the cluster. Valid values:

    • Normal: Cluster Edition

    • Basic: Single Node Edition

    • Archive: X-Engine Edition

    • NormalMultimaster: Multi-master Cluster Edition

    • SENormal: Standard Edition

    Note

    • PolarDB for PostgreSQL 11 does not support Single Node Edition.

    • PolarDB for MySQL 8.0, PolarDB for MySQL 5.7, and PolarDB for PostgreSQL 14 support Standard Edition.

    • PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster Edition.

    Normal
    ResourceGroupId

    string

    The resource group ID.

    rg-***************
    DataLevel1BackupChainSize

    integer

    The total size of level-1 backups (snapshots), in bytes.

    74448896
    DBClusterId

    string

    The cluster ID.

    pc-*****************
    DBType

    string

    The database engine type.

    MySQL
    DBClusterNetworkType

    string

    The network type of the cluster.

    VPC
    IsLatestVersion

    boolean

    Indicates whether the cluster runs the latest Milvus version. Valid values:

    • true: The cluster runs the latest Milvus version.

    • false: The cluster does not run the latest Milvus version.

    false
    HasCompleteStandbyRes

    boolean

    Indicates whether resources are replenished for the new primary node after a cross-zone failover. Valid values:

    • true: Resources are replenished.

    • false: Resources are not replenished.

    false
    HotStandbyCluster

    string

    Indicates whether the Hot Standby Cluster (and standby compute nodes) is enabled. Valid values:

    • StandbyClusterON: The Hot Standby Cluster or both the Hot Standby Cluster and standby compute nodes are enabled.

    • StandbyClusterOFF: The Hot Standby Cluster or both the Hot Standby Cluster and standby compute nodes are disabled.

    StandbyClusterON
    DataSyncMode

    string

    The data replication relationship mode. Valid values:

    • AsyncSync: asynchronous

    • SemiSync: semi-synchronous

    AsyncSync
    StandbyHAMode

    string

    The cross-zone disaster recovery mode. Valid values:

    • ON: Cross-zone disaster recovery is enabled.

    • OFF: Cross-zone disaster recovery is disabled.

    • 0: Customer drill mode.

    OFF
    CompressStorageMode

    string

    Indicates whether storage compression is enabled. Valid values:

    • ON: Enabled.

    • OFF: Disabled.

    ON
    StorageMax

    integer

    The maximum storage capacity for the current cluster specifications, in bytes.

    10995116277760
    DBVersion

    string

    The database engine version.

    8.0
    DBNodes

    array<object>

    The node information.

    object

    CreationTime

    string

    The time when the node was created.

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

    integer

    The failover priority. Each node has a failover priority that determines the probability of the node being elected as the primary node during a failover. A higher value indicates a higher priority. Valid values: 1 to 15.

    1
    MaxIOPS

    integer

    The maximum number of I/O requests per second (IOPS).

    32000
    DBNodeClass

    string

    The node specifications.

    polar.mysql.x4.large
    CpuCores

    string

    The number of CPU cores of the node.

    2
    MemorySize

    string

    The memory size of the node. Unit: MB.

    8192
    DBNodeRole

    string

    The role of the node. Valid values:

    • Writer: primary node.

    • Reader: read-only node.

    Reader
    ZoneId

    string

    The zone ID.

    cn-hangzhou-i
    MaxConnections

    integer

    The maximum number of concurrent connections to the cluster.

    8000
    DBNodeStatus

    string

    The node status. Valid values:

    • Creating: Being created.

    • Running: Running.

    • Deleting: Being deleted.

    • Rebooting: Being restarted.

    • DBNodeCreating: Increase node in progress.

    • DBNodeDeleting: Deleting a node.

    • ClassChanging: Changing node specifications.

    • NetAddressCreating: Creating network connectivity.

    • NetAddressDeleting: Deleting network connectivity.

    • NetAddressModifying: Modifying network connectivity.

    • MinorVersionUpgrading: Upgrade of the minor version in progress.

    • Maintaining: Instance under maintenance.

    • Switching: Switching over.

    Running
    DBNodeId

    string

    The node ID.

    pi-****************
    ImciSwitch

    string

    Indicates whether In-Memory Column Index (IMCI) is enabled. Valid values:

    • ON: Enabled.

    • OFF: Disabled.

    ON
    HotReplicaMode

    string

    Indicates whether hot standby is enabled. Valid values:

    • ON: Enabled.

    • OFF: Disabled.

    ON
    AddedCpuCores

    string

    The number of CPU cores added by second-level rapid scaling.

    6
    MasterId

    string

    The primary node ID of the Multi-master Cluster Edition.

    pi-bp18z52akld3*****
    SccMode

    string

    Indicates whether the global consistency (high-performance mode) feature is enabled for the node. Valid values:

    • ON: Enabled.

    • OFF: Disabled.

    ON
    ServerWeight

    string

    The routing weight. Valid values: 1 to 100. Default value: 1.

    1
    ServerlessType

    string

    The serverless type of the node. Valid values:

    • AgileServerless: agile serverless node.

    • SteadyServerless: steady serverless node, which is a node in a cluster with defined specifications that has serverless capabilities enabled.

    Note

    This parameter is supported only for serverless clusters or clusters with defined specifications that have the serverless feature enabled. For more information, see Serverless.

    SteadyServerless
    SubCluster

    string

    Indicates whether the node is in the primary zone or secondary zone. This parameter is mainly used for resource-equivalent deployments. Valid values:

    • Primary: primary zone.

    • Standby: secondary zone.

    Primary
    RemoteMemorySize

    string

    The remote memory size. Unit: MB.

    3072
    Orca

    string

    The Orca feature. Valid values:

    • on: Enabled.

    • off: Disabled.

    off
    MultiMasterLocalStandby

    string

    The multi-master local standby node.

    pi-****************
    MultiMasterPrimaryNode

    string

    The multi-master primary node.

    pi-****************
    DBNodeDescription

    string

    The node description.

    test
    SubGroupDescription

    string

    The cluster subgroup description.

    test Description
    MirrorInsName

    string

    The name of the hot replica that corresponds to this node in the hot standby storage and compute architecture.

    pi-bp18z52mirror*****
    DBNodeCXLRemoteMemory

    string

    The CXL remote memory configuration.

    3072
    RemoteMemoryMin

    integer

    RemoteMemoryMax

    integer

    RemoteMemoryRecommended

    integer

    ZoneIds

    string

    The zone ID.

    cn-hangzhou-i,cn-hangzhou-g
    MaintainTime

    string

    The maintenance window of the cluster. The time is in the HH:mmZ-HH:mmZ format (UTC). For example, 16:00Z-17:00Z indicates that routine maintenance can be performed from 00:00 to 01:00 (UTC+08:00).

    18:00Z-19:00Z
    Engine

    string

    The cluster engine.

    POLARDB
    Tags

    array<object>

    The tag information.

    object

    Key

    string

    The tag key.

    test
    Value

    string

    The tag value.

    MySQL
    RequestId

    string

    The request ID.

    074467EF-86B9-4C23-ACBF-E9B81A******
    VPCId

    string

    The VPC ID.

    vpc-*******************
    SearchClusterStatus

    string

    The running status of the search node.

    Running
    VSwitchId

    string

    The vSwitch ID.

    vsw-*********************
    DBClusterDescription

    string

    The cluster description.

    test
    Expired

    string

    Indicates whether the cluster has expired.

    Note

    This parameter is returned only for clusters whose billing method is Prepaid (subscription).

    false
    PayType

    string

    The billing method. Valid values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    Prepaid
    StoragePayType

    string

    The storage billing type. Valid values:

    • Postpaid: pay-by-capacity (pay-as-you-go).

    • Prepaid: pay-by-space (subscription).

    Prepaid
    LockMode

    string

    The lock mode. Valid values:

    • Unlock: Not locked.

    • ManualLock: Manually locked.

    • LockByExpiration: Automatically locked due to cluster expiration.

    Unlock
    SearchStorageUsed

    integer

    The storage usage of the search node.

    3012558848
    SearchCompressStorageUsed

    integer

    The compressed storage data size of the search node.

    Note

    This parameter is returned only when the storage compression feature is enabled for the cluster.

    15529410560
    StorageSpace

    integer

    The storage space for pay-by-space (subscription) billing. Unit: bytes.

    50
    DBVersionStatus

    string

    The status of the current minor database version. Valid values:

    • Stable: The current version is stable.

    • Old: The current version is outdated. Upgrade to the latest version.

    • HighRisk: The current version has critical defects. Upgrade to the latest version immediately.

    • Beta: The current version is a beta version.

    Note

    • For information about how to upgrade the minor database version, see Version upgrade.

    • This parameter is returned only when the database engine type (DBType) is MySQL.

    Stable
    CreationTime

    string

    The time when the cluster was created.

    2020-08-14T05:58:42Z
    SQLSize

    integer

    The storage size of SQL statements, in bytes. A value of -1 indicates that no data is available.

    0
    InodeTotal

    integer

    The maximum number of inodes in the file system.

    6,291,456
    InodeUsed

    integer

    The current inode usage.

    4,194,304
    BlktagTotal

    integer

    The maximum number of blktags in the file system.

    7,864,320
    BlktagUsed

    integer

    The current blktag usage.

    5,242,880
    RegionId

    string

    The region ID.

    cn-hangzhou
    ExpireTime

    string

    The expiration time of the cluster.

    Note

    A specific value is returned only for clusters whose billing method is Prepaid (subscription). An empty value is returned for Postpaid (pay-as-you-go) clusters.

    2020-11-14T16:00:00Z
    SubCategory

    string

    The specification type of compute nodes. Valid values:

    • Exclusive: Dedicated

    • General: General-purpose

    Note

    This parameter is returned only for PolarDB for MySQL clusters of the Cluster Edition.

    Exclusive
    IsProxyLatestVersion

    boolean

    Indicates whether the database proxy is the latest version. Valid values:

    • true: The database proxy is the latest version.

    • false: The database proxy is not the latest version.

    false
    StorageType

    string

    The storage type. The value is fixed as HighPerformance.

    HighPerformance
    ServerlessType

    string

    The serverless type of the cluster. Valid values:

    • AgileServerless: agile serverless cluster.

    • SteadyServerless: steady serverless, which is a cluster with defined specifications that has the serverless feature enabled.

    Note

    This parameter is supported only for serverless clusters or clusters with defined specifications that have the serverless feature enabled.

    SteadyServerless
    StrictConsistency

    string

    Indicates whether multi-zone data strong consistency is enabled for the cluster. Valid values:

    • ON: Multi-zone data strong consistency is enabled. This applies to Standard Edition clusters deployed across three zones.

    • OFF: Multi-zone data strong consistency is not enabled.

    ON
    ProxyCpuCores

    string

    The number of CPU cores of the database proxy.

    4
    ProxyStandardCpuCores

    string

    The number of CPU cores in the standard configuration of the database proxy.

    2
    ProxyType

    string

    The database proxy type. Valid values:

    • Exclusive: Dedicated Enterprise Edition

    • General: Standard Enterprise Edition

    Exclusive
    ProxyStatus

    string

    The status of the database proxy. Valid values:

    • Creating: Being created.

    • Running: Running.

    • Deleting: Being released.

    • Rebooting: Being restarted.

    • DBNodeCreating: Increase node in progress.

    • DBNodeDeleting: Deleting a node.

    • ClassChanging: Changing node specifications.

    • NetAddressCreating: Creating network connectivity.

    • NetAddressDeleting: Deleting network connectivity.

    • NetAddressModifying: Modifying network connectivity.

    • Deleted: Released.

    Running
    ProxyServerlessType

    string

    The serverless type of the database proxy. Valid values:

    • AgileServerless: agile serverless cluster.

    • SteadyServerless: steady serverless, which is a cluster with defined specifications (billing method is subscription or pay-as-you-go).

    SteadyServerless
    Architecture

    string

    The CPU architecture. Valid values:

    • X86

    • ARM

    X86
    AiType

    string

    The AI node type. Valid values:

    • SearchNode: search node.

    • DLNode: AI node.

    DLNode
    ProvisionedIops

    string

    2500
    AiCreatingTime

    string

    The start time of the free AI feature.

    2024-03-13T01:20:28Z
    SupportInstantSwitchWithImci

    string

    Indicates whether the failover with hot replica feature that is compatible with IMCI is supported.

    ON
    Orca

    string

    The Orca feature. Valid values:

    • on: Enabled.

    • off: Disabled.

    ON
    SourceDBCluster

    string

    The source cluster ID.

    Note This parameter is supported only for clusters restored from a backup set or point in time after June 1, 2024.

    pc-pz51ziv48317b2880
    RestoreType

    string

    The cluster restoration method. Valid values:

    • RestoreByTime: Restored from a point in time based on a level-1 backup.

    • RestoreByBackupSet: Restored from a backup set based on a level-1 backup.

    • RestoreByTimeOss: Restored from a point in time based on a level-2 backup.

    • RestoreByBackupSetOss: Restored from a backup set based on a level-2 backup.

    • CloneFromSourceCluster: Cloned from the source cluster.

    Note This parameter is supported only for clusters restored from a backup set or point in time after June 1, 2024.

    RestoreByTime
    RestoreDataPoint

    string

    • If RestoreType is RestoreByTime or RestoreByTimeOss, this value indicates the point in time to which the cluster was restored.

    • If RestoreType is RestoreByBackupSet or RestoreByBackupSetOss, this value indicates the backup set ID used for the restoration.

    Note This parameter is supported only for clusters restored from a backup set or point in time after June 1, 2024.

    2179639137
    SourceRegionId

    string

    The region ID of the source cluster.

    Note This parameter is returned only when the source cluster ID exists.

    cn-beijing
    ImciAutoIndex

    string

    The automatic IMCI-based query acceleration feature. Valid values:

    • ON: Enabled.

    • OFF: Disabled.

    OFF
    AutoUpgradeMinorVersion

    string

    The minor version update method. Valid values:

    • Auto: Automatic update.

    • Manual: Manual update.

    Manual
    BurstingEnabled

    string

    Indicates whether I/O performance burst is enabled for the ESSD AutoPL cloud disk. Valid values:

    • true: Enabled.

    • false: Disabled.

    false
    RowCompression

    string

    The row compression setting.

    OFF

    ImperceptibleSwitch

    string

    The failover with hot replica feature. Valid values:

    • true: Enabled.

    • false: Disabled.

    true
    StorageUsed

    integer

    The storage usage, in bytes.

    3012558848
    CompressStorageUsed

    integer

    The compressed storage data size.

    Note

    This parameter is returned only when the storage compression feature is enabled for the cluster.

    15529410560
    DBClusterStatus

    string

    The cluster status. For more information, see Cluster status table.

    Running
    Branch

    object

    ParentInsName

    string

    BranchTime

    string

    BranchLsn

    string

    ChildBranch

    array<object>

    object

    InsName

    string

    DBClusterDescription

    string

    BranchTime

    string

    BranchLsn

    string

    HasChild

    boolean

    ColumnTable

    string

    Indicates whether column store tables are enabled.

    OFF
    ConnectionResourceQuota

    integer

    ConnectionResourceUsed

    integer

    StorageUpperBound

    integer

    StorageAutoScale

    string

    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": [
    {
      "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": "SteadyServerless",
      "SubCluster": "Primary",
      "RemoteMemorySize": "3072",
      "Orca": "off",
      "MultiMasterLocalStandby": "pi-****************",
      "MultiMasterPrimaryNode": "pi-****************",
      "DBNodeDescription": "test",
      "SubGroupDescription": "test Description",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": "3072",
      "RemoteMemoryMin": 0,
      "RemoteMemoryMax": 0,
      "RemoteMemoryRecommended": 0
    }
  ],
  "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-*******************",
  "SearchClusterStatus": "Running",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 3012558848,
  "SearchCompressStorageUsed": 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": "SteadyServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "SteadyServerless",
  "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": "OFF\n",
  "ImperceptibleSwitch": "true",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running",
  "Branch": {
    "ParentInsName": "",
    "BranchTime": "",
    "BranchLsn": "",
    "ChildBranch": [
      {
        "InsName": "",
        "DBClusterDescription": "",
        "BranchTime": "",
        "BranchLsn": "",
        "HasChild": false
      }
    ]
  },
  "ColumnTable": "OFF",
  "ConnectionResourceQuota": 0,
  "ConnectionResourceUsed": 0,
  "StorageUpperBound": 0,
  "StorageAutoScale": ""
}

    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.