All Products
Search
Document Center

PolarDB:DescribeDBClusterAttribute

Last Updated:Nov 07, 2023

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.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBClusterAttributeREAD
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of cluster.

Note You can call the DescribeDBClusters operation to query the details of the clusters that belong to your Alibaba Cloud account, such as cluster IDs.
pc-*****************
DescribeTypestringNo

Specifies whether to query information about AI-related nodes.

AI

Response parameters

ParameterTypeDescriptionExample
object
DeletionLockinteger

Indicates whether the cluster is locked and can be deleted. Valid values:

  • 0: The cluster is not locked and can be deleted.
  • 1: The cluster is locked and cannot be deleted.
0
Categorystring

The edition of PolarDB. Valid values:

  • Normal: Cluster Edition.
  • Basic: Single Node Edition.
  • Archive: X-Engine Edition.
  • NormalMultimaster: Multi-master Cluster Edition.
  • SENormal: Standard Edition.
Note
  • Only PolarDB for MySQL supports Single Node Edition.
  • Only PolarDB for MySQL 8.0.1 supports Standard Edition.
  • Only PolarDB for MySQL 8.0 supports X-Engine Edition and Multi-master Cluster Edition.
  • Normal
    ResourceGroupIdstring

    The ID of your Alibaba Cloud resource group.

    rg-***************
    DataLevel1BackupChainSizelong

    The total physical storage of level-1 backups (snapshots). Unit: bytes.

    74448896
    DBClusterIdstring

    The ID of cluster.

    pc-*****************
    DBTypestring

    The type of the database engine.

    MySQL
    DBClusterNetworkTypestring

    The network type of the cluster.

    VPC
    IsLatestVersionboolean

    Indicates whether the kernel is of the latest version. Valid values:

    • true
    • false
    false
    HasCompleteStandbyResboolean

    Indicates whether to replenish resources for the primary database after a cross-zone switchover. Valid values: true false

    false
    DataSyncModestring

    Indicates the rule of data replication. Valid values: AsyncSync: asynchronous. SemiSync: semi-synchronous.

    AsyncSync
    StandbyHAModestring

    Indicates whether the cross-zone disaster recovery feature is enabled. Valid values: ON OFF 0: Customer Drill Mode

    OFF
    StorageMaxlong

    The maximum storage capacity of the current cluster specification. Unit: bytes.

    10995116277760
    DBVersionstring

    The version of the database engine.

    8.0
    DBNodesobject []

    The details of the nodes.

    CreationTimestring

    The time when the node was created.

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

    The failover priority. Each node is assigned a failover priority. If a failover occurs, a node can be selected as a primary node. The priority determines the probability at which a node is selected as a primary node. A larger value indicates a higher priority. Valid values: 1 to 15.

    1
    MaxIOPSinteger

    The maximum input/output operations per second (IOPS).

    32000
    DBNodeClassstring

    The type of the node.

    polar.mysql.x4.large
    DBNodeRolestring

    The role of the node. Valid values:

    • Writer: The node is the primary node.
    • Reader: The node is a read-only node.
    Reader
    ZoneIdstring

    The ID of the zone.

    cn-hangzhou-i
    MaxConnectionsinteger

    The maximum number of concurrent connections in the cluster.

    8000
    DBNodeStatusstring

    The status of the node. Valid values:

    • Creating: The cluster is being created.
    • Running: The cluster is running.
    • Deleting: The cluster is being deleted.
    • Rebooting: The cluster is restarting.
    • DBNodeCreating: PolarProxy is being added.
    • DBNodeDeleting: PolarProxy is being deleted.
    • ClassChanging: The specification type of PolarProxy are being modified.
    • NetAddressCreating: The network connection is being created.
    • NetAddressDeleting: The network connection is being deleted.
    • NetAddressModifying: The network connection is being modified.
    • MinorVersionUpgrading: The minor version is being updated.
    • Maintaining: The cluster is being maintained.
    • Switching: A failover is being performed.
    Running
    DBNodeIdstring

    The ID of the node.

    pi-****************
    ImciSwitchstring

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

    • ON
    • OFF
    ON
    HotReplicaModestring

    Indicates whether the hot standby feature is enabled. Valid values:

    • ON
    • OFF
    ON
    AddedCpuCoresstring

    The number of CPU cores for compute node scale-out within seconds.

    6
    MasterIdstring

    The ID of the primary node in the cluster that runs Multi-master Cluster Edition.

    pi-bp18z52akld3*****
    SccModestring

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

    • ON
    • OFF
    ON
    ServerWeightstring

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

    1
    ServerlessTypestring

    The type of the serverless node. Only AgileServerless can be returned.

    Note This parameter is supported only for serverless clusters.
    AgileServerless
    ZoneIdsstring

    The zone ID of the cluster.

    cn-hangzhou-i,cn-hangzhou-g
    MaintainTimestring

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

    18:00Z-19:00Z
    Enginestring

    The database type.

    POLARDB
    Tagsobject []

    Details about the tags.

    Keystring

    The key of the tag.

    test
    Valuestring

    The value of the tag.

    MySQL
    RequestIdstring

    The ID of the request.

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

    The VPC ID of the cluster.

    vpc-*******************
    DBClusterStatusstring

    The status of the cluster. For information about the valid values, see Cluster states.

    Running
    VSwitchIdstring

    The vSwitch ID of the cluster.

    vsw-*********************
    DBClusterDescriptionstring

    The description of the cluster.

    test
    Expiredstring

    Indicates whether the cluster has expired. Valid values:

    Note This parameter is returned only for subscription (Prepaid) clusters.
    false
    PayTypestring

    The billing method of the cluster. Valid values:

    • Postpaid: pay-as-you-go.
    • Prepaid: subscription
    Prepaid
    StoragePayTypestring

    The billing method of the storage. Valid values:

    • Postpaid: pay-as-you-go
    • Prepaid: subscription.
    Prepaid
    LockModestring

    The lock mode. Valid values:

    • Unlock: The cluster is not locked.
    • ManualLock: The cluster is manually locked.
    • LockByExpiration: The cluster is automatically locked due to cluster expiration.
    Unlock
    StorageUsedlong

    The storage space consumed by the cluster. Unit: bytes.

    3012558848
    StorageSpacelong

    The storage space that uses the subscription billing method. Unit: bytes.

    50
    DBVersionStatusstring

    The status of the minor version. Valid values:

    • Stable: The minor version is stable.
    • Old: The minor version is outdated. We recommend that you upgrade the cluster to the latest version.
    • HighRisk: The minor version has critical defects. We recommend that you immediately upgrade the cluster to the latest version.
    Note For more information about how to upgrade the minor version, see Upgrade versions.
    Stable
    CreationTimestring

    The time when the cluster was created.

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

    The storage of SQL. Unit: bytes. If the value is -1, no data is stored.

    0
    InodeTotallong

    Maximum inodes in file system.

    6,291,456
    InodeUsedlong

    The current inode usage.

    4,194,304
    BlktagTotallong

    Maximum blktags in file system.

    7,864,320
    BlktagUsedlong

    The current blktag usage.

    5,242,880
    RegionIdstring

    The region ID of the security group.

    cn-hangzhou
    ExpireTimestring

    The time when the cluster expires.

    Note A specific value will be returned only for subscription (Prepaid) clusters. For pay-as-you-go (Postpaid) clusters, an empty string will be returned.
    2020-11-14T16:00:00Z
    SubCategorystring

    The specification type of the compute node. Valid values:

    • Exclusive: dedicated.
    • General: general-purpose.
    Note This parameter is supported only for PolarDB for MySQL clusters of Cluster Edition.
    Exclusive
    DeployUnitstring

    The unit to which the cluster belongs.

    default
    IsProxyLatestVersionboolean

    Indicates whether PolarProxy uses the latest version. Valid values:

    • true
    • false
    false
    StorageTypestring

    The storage type. Set the value to HighPerformance.

    HighPerformance
    ServerlessTypestring

    The type of the serverless cluster. Only AgileServerless can be returned.

    AgileServerless
    StrictConsistencystring

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

    • ON: Multi-zone data consistency is enabled, which is suitable for Standard Edition clusters that run Multi-zone Edition.
    • OFF
    ON
    ProxyCpuCoresstring

    The number of CPU cores for PolarProxy.

    4
    ProxyStandardCpuCoresstring

    The number of CPU cores for PolarProxy Standard Enterprise Edition.

    2
    ProxyTypestring

    The type of PolarProxy. Valid values:

    • Exclusive: Dedicated Enterprise Edition
    • General: Standard Enterprise Edition
    Exclusive
    ProxyStatusstring

    The status of PolarProxy. Valid values:

    • Creating: PolarProxy is being created.
    • Running: PolarProxy is running.
    • Deleting: PolarProxy is being released.
    • Rebooting: PolarProxy is restarting.
    • DBNodeCreating: PolarProxy is being added.
    • DBNodeDeleting: PolarProxy is being deleted.
    • ClassChanging: The specifications of PolarProxy are being changed.
    • NetAddressCreating: The network connection is being created.
    • NetAddressDeleting: The network connection is being deleted.
    • NetAddressModifying: The network connection is being modified.
    • Deleted: PolarProxy is released.
    Running
    ProxyServerlessTypestring

    The type of the serverless PolarProxy. Valid value: AgileServerless.

    AgileServerless
    AiTypestring

    The information status of the AI node. Valid values:

    • SearchNode: search node.
    • DLNode: AI node
    DLNode

    Examples

    Sample success responses

    JSONformat

    {
      "DeletionLock": 0,
      "Category": "Normal",
      "ResourceGroupId": "rg-***************",
      "DataLevel1BackupChainSize": 74448896,
      "DBClusterId": "pc-*****************",
      "DBType": "MySQL",
      "DBClusterNetworkType": "VPC",
      "IsLatestVersion": false,
      "HasCompleteStandbyRes": false,
      "DataSyncMode": "AsyncSync",
      "StandbyHAMode": "OFF",
      "StorageMax": 10995116277760,
      "DBVersion": "8.0",
      "DBNodes": [
        {
          "CreationTime": "2020-03-23T21:35:43Z",
          "FailoverPriority": 1,
          "MaxIOPS": 32000,
          "DBNodeClass": "polar.mysql.x4.large",
          "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"
        }
      ],
      "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,
      "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",
      "DeployUnit": "default",
      "IsProxyLatestVersion": false,
      "StorageType": "HighPerformance",
      "ServerlessType": "AgileServerless",
      "StrictConsistency": "ON",
      "ProxyCpuCores": "4",
      "ProxyStandardCpuCores": "2",
      "ProxyType": "Exclusive",
      "ProxyStatus": "Running",
      "ProxyServerlessType": "AgileServerless",
      "AiType": "DLNode"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The specified DBClusterId parameter is invalid.
    403Forbidden.RAMUser not authorized to operate on the specified resource, or this API does not support RAM.-
    404InvalidDBCluster.NotFoundThe 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 timeSummary of changesOperation
    2023-11-06The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2023-10-26The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2023-10-12The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2023-09-12The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2023-08-31The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2023-07-06The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: DescribeType
    Output ParametersThe response structure of the API operation changes.
    2023-06-12The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 403
    2023-04-11The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2023-03-28API Description Update,The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2022-11-02The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2022-06-02The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2021-12-07The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2021-12-07The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2021-12-07The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
    2021-12-07The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2021-12-07The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.