全部產品
Search

搜尋本產品

    PolarDB：DescribeDBClusterAttribute

    文件中心

    PolarDB：DescribeDBClusterAttribute

    更新時間：Jul 14, 2026

    檢視叢集屬性資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeDBClusterAttribute

    get

    *DBCluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    說明

    您可以透過 DescribeDBClusters 介面檢視帳號下所有叢集的詳細資訊，包括叢集 ID。

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

    string

    否

    是否取得 AI 相關節點資訊。

    AI

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    DeletionLock

    integer

    叢集刪除的鎖定狀態，取值範圍如下：

    • 0：未鎖定，可刪除叢集。

    • 1：鎖定，不可刪除叢集。

    0
    Category

    string

    產品系列，取值範圍如下：

    • Normal：叢集版

    • Basic：單節點

    • Archive：高壓縮引擎（X-Engine）

    • NormalMultimaster：多主架構叢集版

    • SENormal：標準版

    說明

    • PolarDB PostgreSQL 版 PostgreSQL 11 版本不支援單節點。

    • PolarDB MySQL 版 8.0 版本、5.7 版本，PolarDB PostgreSQL 版 PostgreSQL 14 版本支援標準版。

    • PolarDB MySQL 版 8.0 版本，支援高壓縮引擎（X-Engine）和多主架構叢集版。

    Normal
    ResourceGroupId

    string

    資源群組 ID。

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

    integer

    一級備份（快照）總大小，單位為位元組。

    74448896
    DBClusterId

    string

    叢集 ID。

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

    string

    資料庫引擎類型。

    MySQL
    DBClusterNetworkType

    string

    叢集的網路類型。

    VPC
    IsLatestVersion

    boolean

    是否為最新核心版本。取值範圍如下：

    • true：是

    • false：否

    false
    HasCompleteStandbyRes

    boolean

    是否在跨可用區切換後補齊新主資料庫資源。取值範圍如下：

    • true：是

    • false：否

    false
    HotStandbyCluster

    string

    是否開啟儲存熱備叢集（和 Standby 計算節點）。取值範圍如下：

    • StandbyClusterON：開啟儲存熱備/開啟儲存熱備和 Standby 計算節點。

    • StandbyClusterOFF：關閉儲存熱備/關閉儲存熱備和 Standby 計算節點。

    StandbyClusterON
    DataSyncMode

    string

    資料複製關係模式。取值範圍如下：

    • AsyncSync：非同步

    • SemiSync：半同步

    AsyncSync
    StandbyHAMode

    string

    跨可用容災模式。取值範圍如下：

    • ON：開啟跨可用容災模式。

    • OFF：關閉跨可用容災模式。

    • 0：客戶演練模式。

    OFF
    CompressStorageMode

    string

    是否為開啟儲存壓縮。取值範圍如下：

    • ON：開啟

    • OFF：關閉

    ON
    StorageMax

    integer

    目前叢集規格的最大儲存容量，單位為位元組。

    10995116277760
    DBVersion

    string

    資料庫引擎版本。

    8.0
    DBNodes

    array<object>

    節點資訊詳情。

    object

    CreationTime

    string

    節點建立時間。

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

    integer

    Failover 優先順序。每個節點都有一個 Failover 優先順序，決定了當故障切換時，該節點被選舉為主節點的機率高低。數值越大，優先順序越高。 取值範圍為 1~15。

    1
    MaxIOPS

    integer

    最大 I/O 請求次數，即 IOPS。

    32000
    DBNodeClass

    string

    節點規格。

    polar.mysql.x4.large
    CpuCores

    string

    節點 CPU 核心數。

    2
    MemorySize

    string

    節點記憶體大小，單位：MB。

    8192
    DBNodeRole

    string

    節點角色，取值範圍如下：

    • Writer：主節點。

    • Reader：唯讀節點。

    Reader
    ZoneId

    string

    可用區 ID。

    cn-hangzhou-i
    MaxConnections

    integer

    最大叢集並行連線數。

    8000
    DBNodeStatus

    string

    節點狀態，取值範圍如下：

    • Creating：建立中

    • Running：執行中

    • Deleting：刪除中

    • Rebooting：重新啟動中

    • DBNodeCreating：正在增加節點

    • DBNodeDeleting：正在刪除節點

    • ClassChanging：正在變更節點規格

    • NetAddressCreating：正在建立網路連線

    • NetAddressDeleting：正在刪除網路連線

    • NetAddressModifying：正在修改網路連線

    • MinorVersionUpgrading：小版本升級中

    • Maintaining：執行個體維護中

    • Switching：切換中

    Running
    DBNodeId

    string

    節點 ID。

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

    string

    是否開啟列存索引。取值範圍如下：

    • ON：開啟

    • OFF：關閉

    ON
    HotReplicaMode

    string

    是否開啟熱備。取值範圍如下：

    • ON：開啟

    • OFF：關閉

    ON
    AddedCpuCores

    string

    秒級彈性擴核的 CPU 核心數。

    6
    MasterId

    string

    多主架構叢集版的主節點 ID。

    pi-bp18z52akld3*****
    SccMode

    string

    節點是否開啟全域一致性（高效能模式）功能。取值範圍如下：

    • ON：開啟

    • OFF：關閉

    ON
    ServerWeight

    string

    路由權重。 取值範圍：1~100。預設值為 1。

    1
    ServerlessType

    string

    節點的 Serverless 類型。取值範圍如下：

    • AgileServerless：敏態，即 Serverless 節點。

    • SteadyServerless：穩態，即在固定規格節點上疊加了 Serverless 能力。

    說明

    • 僅在 Serverless 叢集或開啟了 Serverless 功能的固定規格叢集，才支援該參數。詳細說明，請參見 Serverless 。

    SteadyServerless
    SubCluster

    string

    檢視節點是在主可用區還是備用可用區，主要是資源對等形態在用。 取值範圍如下：

    • Primary：主可用區

    • Standby：備用可用區

    Primary
    RemoteMemorySize

    string

    遠端記憶體大小，單位：MB。

    3072
    Orca

    string

    Orca 功能，取值範圍如下：

    • on：開啟

    • off: 關閉

    off
    MultiMasterLocalStandby

    string

    多主本地備用節點。

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

    string

    多主主節點。

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

    string

    節點描述。

    test
    SubGroupDescription

    string

    叢集子群組描述。

    test Description
    MirrorInsName

    string

    開啟儲存熱備和計算熱備架構中，節點對應的計算熱備節點名稱。

    pi-bp18z52mirror*****
    DBNodeCXLRemoteMemory

    string

    CXL 遠端記憶體配置。

    3072
    RemoteMemoryMin

    integer

    RemoteMemoryMax

    integer

    RemoteMemoryRecommended

    integer

    ZoneIds

    string

    可用區 ID。

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

    string

    叢集的可維護時間段，格式為 HH:mmZ-HH:mmZ（UTC 時間）。例如 16:00Z-17:00Z 表示，0 點到 1 點（UTC+08:00）可以進行例行維護。

    18:00Z-19:00Z
    Engine

    string

    叢集引擎。

    POLARDB
    Tags

    array<object>

    標籤資訊詳情。

    object

    Key

    string

    標籤鍵。

    test
    Value

    string

    標籤值。

    MySQL
    RequestId

    string

    請求 ID。

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

    string

    專有網路 ID。

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

    string

    搜尋節點執行狀態。

    Running
    VSwitchId

    string

    虛擬交換器 ID。

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

    string

    叢集描述。

    test
    Expired

    string

    叢集是否到期。

    說明

    僅付費方式為 Prepaid（包年包月）的叢集支援返回該參數。

    false
    PayType

    string

    付費類型。取值範圍如下：

    • Postpaid：按量付費。

    • Prepaid：預付費（包年包月）。

    Prepaid
    StoragePayType

    string

    儲存計費類型。取值範圍如下：

    • Postpaid：按容量計費（按量付費）。

    • Prepaid：按空間計費（包年包月）。

    Prepaid
    LockMode

    string

    鎖定模式。取值範圍如下：

    • Unlock：未鎖定。

    • ManualLock：手動觸發鎖定。

    • LockByExpiration：叢集過期自動鎖定。

    Unlock
    SearchStorageUsed

    integer

    Search 節點儲存使用情況。

    3012558848
    SearchCompressStorageUsed

    integer

    Search 節點壓縮後的儲存資料大小。

    說明

    僅當叢集開啟儲存壓縮功能後支援返回該參數。

    15529410560
    StorageSpace

    integer

    按空間計費（包年包月）的儲存空間。單位：位元組。

    50
    DBVersionStatus

    string

    目前資料庫小版本狀態，取值範圍如下：

    • Stable：目前版本狀態穩定。

    • Old：目前版本過舊，建議升級到最新版本。

    • HighRisk：目前版本有嚴重缺陷，請立即升級到最新的版本。

    • Beta：目前版本為 Beta 版。

    說明

    • 關於如何升級資料庫小版本，請參見版本升級。

    • 僅當資料庫引擎類型（DBType）為 MySQL 時，返回目前參數。

    Stable
    CreationTime

    string

    叢集建立時間。

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

    integer

    SQL 的儲存量，單位為位元組。若數值為 -1，則表示沒有資料。

    0
    InodeTotal

    integer

    檔案系統最大 inode 數。

    6,291,456
    InodeUsed

    integer

    目前 inode 使用量。

    4,194,304
    BlktagTotal

    integer

    檔案系統最大 blktag 數。

    7,864,320
    BlktagUsed

    integer

    目前 blktag 使用量。

    5,242,880
    RegionId

    string

    地域 ID。

    cn-hangzhou
    ExpireTime

    string

    叢集到期時間。

    說明

    僅付費方式為 Prepaid（包年包月）的叢集會返回具體參數值，Postpaid（按量付費）叢集則返回空值。

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

    string

    計算節點的規格類型，取值範圍如下：

    • Exclusive：獨享規格

    • General：通用規格

    說明

    僅 PolarDB MySQL 版且產品系列為叢集版時，支援返回該參數。

    Exclusive
    IsProxyLatestVersion

    boolean

    是否為資料庫代理最新版本，取值範圍如下：

    • true：是

    • false：否

    false
    StorageType

    string

    儲存類型，取值固定為 HighPerformance。

    HighPerformance
    ServerlessType

    string

    叢集 Serverless 類型。取值範圍如下：

    • AgileServerless：敏態，即 Serverless 叢集。

    • SteadyServerless：穩態，即開啟了 Serverless 功能的固定規格叢集。

    說明

    僅在 Serverless 叢集或開啟了 Serverless 功能的固定規格叢集，才支援該參數。

    SteadyServerless
    StrictConsistency

    string

    叢集是否開啟了多可用區資料強一致。取值範圍如下：

    • ON：表示開啟了多可用區資料強一致，適用於標準版 3AZ 場景。

    • OFF：表示未開啟多可用區資料強一致。

    ON
    ProxyCpuCores

    string

    資料庫代理 CPU 核心數。

    4
    ProxyStandardCpuCores

    string

    資料庫代理標準配置 CPU 核心數。

    2
    ProxyType

    string

    資料庫代理類型，取值範圍如下：

    • Exclusive：企業獨享版

    • General ：企業通用版

    Exclusive
    ProxyStatus

    string

    資料庫代理的狀態。取值範圍如下：

    • Creating：建立中

    • Running：執行中

    • Deleting：釋放中

    • Rebooting：重新啟動中

    • DBNodeCreating：正在增加節點

    • DBNodeDeleting：正在刪除節點

    • ClassChanging：正在變更節點規格

    • NetAddressCreating：正在建立網路連線

    • NetAddressDeleting：正在刪除網路連線

    • NetAddressModifying：正在修改網路連線

    • Deleted：已釋放

    Running
    ProxyServerlessType

    string

    資料庫代理 Serverless 類型。取值範圍如下：

    • AgileServerless：敏態，即 Serverless 叢集。

    • SteadyServerless：穩態，即固定規格叢集（計費類型為包年包月或按量付費的叢集）。

    SteadyServerless
    Architecture

    string

    CPU 架構。取值範圍如下：

    • X86

    • ARM

    X86
    AiType

    string

    AI 節點類型。取值範圍如下：

    • SearchNode：搜尋節點。

    • DLNode：AI 節點。

    DLNode
    ProvisionedIops

    string

    2500
    AiCreatingTime

    string

    開啟免費 AI 起始時間。

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

    string

    是否支援相容列存 IMCI 的無感秒切功能。

    ON
    Orca

    string

    Orca 功能，取值如下：

    • on：開啟

    • off：關閉

    ON
    SourceDBCluster

    string

    來源叢集 ID。

    說明 僅 2024 年 6 月 1 日以後從備份集或時間點復原的叢集支援該參數。

    pc-pz51ziv48317b2880
    RestoreType

    string

    叢集復原方式，其值可能為：

    • RestoreByTime：基於一級備份從時間點復原。

    • RestoreByBackupSet：基於一級備份從備份集復原。

    • RestoreByTimeOss：基於二級備份從時間點復原。

    • RestoreByBackupSetOss：基於二級備份從備份集復原。

    • CloneFromSourceCluster：從來源叢集複製。

    說明 僅 2024 年 6 月 1 日以後從備份集或時間點復原的叢集支援該參數。

    RestoreByTime
    RestoreDataPoint

    string

    • 若 RestoreType 為 RestoreByTime 或 RestoreByTimeOss，該值表示復原的時間點。

    • 若 RestoreType 為 RestoreByBackupSet 或 RestoreByBackupSetOss，該值表示復原所基於的備份集 ID。

    說明 僅 2024 年 6 月 1 日以後從備份集或時間點復原的叢集支援該參數。

    2179639137
    SourceRegionId

    string

    來源叢集所處地域 ID。

    說明 僅來源叢集 ID 存在的情況下才可能返回。

    cn-beijing
    ImciAutoIndex

    string

    自動列存索引提速功能。取值範圍如下：

    • ON：開啟。

    • OFF：關閉。

    OFF
    AutoUpgradeMinorVersion

    string

    小版本升級方式。

    • Auto：自動升級

    • Manual：手動升級

    Manual
    BurstingEnabled

    string

    ESSD AutoPL 雲端硬碟是否開啟 IO 效能突發。取值：

    • true：開啟

    • false：關閉

    false
    RowCompression

    string

    行壓縮設定。

    OFF

    ImperceptibleSwitch

    string

    無感切換。取值範圍如下：

    • true：開啟。

    • false：關閉。

    true
    StorageUsed

    integer

    儲存空間的使用量，單位為位元組。

    3012558848
    CompressStorageUsed

    integer

    壓縮後的儲存資料大小。

    說明

    僅當叢集開啟儲存壓縮功能後支援返回該參數。

    15529410560
    DBClusterStatus

    string

    叢集狀態，取值範圍請參見叢集狀態表。

    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

    是否開啟列存表。

    OFF
    ConnectionResourceQuota

    integer

    ConnectionResourceUsed

    integer

    StorageUpperBound

    integer

    StorageAutoScale

    string

    樣本

    正常返回樣本

    JSON格式

    {
  "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": ""
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    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. 操作失敗，指定的叢集執行個體 ID 不存在。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。