すべてのプロダクト
Search

このプロダクト

    :DescribeDBClusterAttribute

    ドキュメントセンター

    :DescribeDBClusterAttribute

    最終更新日:Dec 11, 2025

    指定されたクラスターの属性を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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: Multi-master Cluster Edition

    • SENormal: Standard Edition

    説明

    • PostgreSQL 11 を実行する PolarDB for PostgreSQL (Oracle 互換) は、シングルノード版をサポートしていません。

    • MySQL 8.0 または 5.7 を実行する PolarDB for MySQL および PostgreSQL 14 を実行する PolarDB for PostgreSQL (Oracle 互換) は、Standard Edition をサポートしています。

    • MySQL 8.0 を実行する PolarDB for MySQL は、X-Engine と Multi-master Cluster Edition をサポートしています。

    Normal
    ResourceGroupId

    string

    リソースグループ ID。

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

    integer

    レベル 1 バックアップ (スナップショット) の合計サイズ。単位: バイト。

    74448896
    DBClusterId

    string

    クラスター ID。

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

    string

    データベースエンジンタイプ。

    MySQL
    DBClusterNetworkType

    string

    クラスターのネットワークタイプ。

    VPC
    IsLatestVersion

    boolean

    カーネルが最新バージョンであるかどうかを示します。有効な値:

    • true

    • false

    false
    HasCompleteStandbyRes

    boolean

    クロスゾーンフェールオーバー後に新しいプライマリデータベースのリソースがプロビジョニングされるかどうかを示します。有効な値:

    • true

    • false

    false
    HotStandbyCluster

    string

    ストレージホットスタンバイクラスター (およびスタンバイ計算ノード) が有効になっているかどうかを示します。有効な値:

    • StandbyClusterON: ストレージホットスタンバイクラスター、またはストレージホットスタンバイクラスターとスタンバイ計算ノードの両方が有効になっています。

    • StandbyClusterOFF: ストレージホットスタンバイクラスター、またはストレージホットスタンバイクラスターとスタンバイ計算ノードの両方が無効になっています。

    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

    フェールオーバーの優先度。各ノードにはフェールオーバーの優先度があります。値が大きいほど、フェールオーバー中にノードがプライマリノードに昇格する優先度が高くなります。 有効な値: 1～15。

    1
    MaxIOPS

    integer

    1 秒あたりの最大入出力操作数 (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

    インメモリ列インデックス (IMCI) 機能が有効かどうかを示します。有効な値:

    • ON: 有効

    • OFF: 無効

    ON
    HotReplicaMode

    string

    ホットレプリカ機能が有効かどうかを示します。有効な値:

    • ON: 有効

    • OFF: 無効

    ON
    AddedCpuCores

    string

    数秒以内に弾性スケーリング機能のために追加される CPU コアの数。

    6
    MasterId

    string

    Multi-master Cluster Edition クラスターのプライマリノードの ID。

    pi-bp18z52akld3*****
    SccMode

    string

    ノードでグローバル整合性 (パフォーマンス専有型モード) が有効になっているかどうかを示します。有効な値:

    • ON: 有効

    • OFF: 無効

    ON
    ServerWeight

    string

    ルーティングの重み。 有効な値: 1～100。デフォルト値: 1。

    1
    ServerlessType

    string

    ノードのサーバーレスタイプ。有効な値:

    • AgileServerless: アジャイル。定義された仕様のノードを示します。

    • SteadyServerless: ステディ。サーバーレスノードを示します。

    説明

    このパラメーターは、サーバーレスクラスター、またはサーバーレス機能が有効になっている定義済みの仕様を持つクラスターでのみサポートされます。

    SteadyServerless
    SubCluster

    string

    ノードがプライマリゾーンにあるかセカンダリゾーンにあるかを示します。このパラメーターは主にピアリソースに使用されます。 有効な値:

    • Primary: プライマリゾーン

    • Standby: セカンダリゾーン

    Primary
    RemoteMemorySize

    string

    リモートメモリのサイズ。単位: MB。

    3072
    Orca

    string

    Orca 機能。有効な値:

    • on: 有効

    • off: 無効

    off
    MultiMasterLocalStandby

    string

    MultiMasterPrimaryNode

    string

    DBNodeDescription

    string

    ノードの説明。

    test
    SubGroupDescription

    string

    MirrorInsName

    string

    ホットスタンバイストレージとホットスタンバイコンピューティングの両方が有効になっているアーキテクチャで、ノードに対応するホットレプリカ計算ノードの名前。

    pi-bp18z52mirror*****
    DBNodeCXLRemoteMemory

    string

    ZoneIds

    string

    ゾーン ID。

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

    string

    クラスターのメンテナンスウィンドウ。時刻は HH:mmZ-HH:mmZ 形式で、UTC です。たとえば、16:00Z-17:00Z は、00:00 から 01:00 (UTC+8) まで定期メンテナンスを実行できることを示します。

    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

    VPC (VPC) ID。

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

    string

    VSwitchId

    string

    vSwitch ID。

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

    string

    クラスターの説明。

    test
    Expired

    string

    クラスターが期限切れになったかどうかを示します。

    説明

    このパラメーターは、サブスクリプションクラスターに対してのみ返されます。

    false
    PayType

    string

    課金方法。有効な値:

    • Postpaid: 従量課金。

    • Prepaid: サブスクリプション。

    Prepaid
    StoragePayType

    string

    ストレージの課金方法。有効な値:

    • Postpaid: 従量課金。

    • Prepaid: サブスクリプション。

    Prepaid
    LockMode

    string

    ロックモード。有効な値:

    • Unlock: クラスターはロックされていません。

    • ManualLock: クラスターは手動でロックされます。

    • LockByExpiration: クラスターは有効期限が切れると自動的にロックされます。

    Unlock
    SearchStorageUsed

    integer

    SearchCompressStorageUsed

    integer

    StorageSpace

    integer

    サブスクリプションクラスターのストレージ容量。単位: バイト。

    50
    DBVersionStatus

    string

    マイナーエンジンバージョンのステータス。有効な値:

    • Stable: 現在のバージョンは安定しています。

    • Old: 現在のバージョンは古いです。クラスターを最新バージョンにアップグレードすることをお勧めします。

    • HighRisk: 現在のバージョンには重大な欠陥があります。クラスターをすぐに最新バージョンにアップグレードすることをお勧めします。

    • 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

    クラスターの有効期限。

    説明

    このパラメーターは、サブスクリプションクラスターに対してのみ返されます。従量課金クラスターの場合は空の値が返されます。

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

    string

    計算ノードの仕様タイプ。有効な値:

    • Exclusive: 専用

    • General: 汎用

    説明

    このパラメーターは、PolarDB for MySQL クラスター版クラスターに対してのみ返されます。

    Exclusive
    IsProxyLatestVersion

    boolean

    データベースプロキシが最新バージョンであるかどうかを示します。有効な値:

    • true

    • false

    false
    StorageType

    string

    ストレージタイプ。値は HighPerformance に固定されています。

    HighPerformance
    ServerlessType

    string

    クラスターのサーバーレスタイプ。有効な値:

    • AgileServerless: アジャイル。サーバーレスクラスターを示します。

    • SteadyServerless: ステディ。サーバーレス機能が有効になっている定義済みの仕様を持つクラスターを示します。

    説明

    このパラメーターは、サーバーレスクラスター、またはサーバーレス機能が有効になっている定義済みの仕様を持つクラスターでのみサポートされます。

    SteadyServerless
    StrictConsistency

    string

    マルチゾーンデータに対して強力な整合性が有効になっているかどうかを示します。有効な値:

    • ON: マルチゾーンデータに対して強力な整合性が有効になっています。これは、3 つのゾーンにまたがってデプロイされている Standard Edition クラスターに適用されます。

    • OFF: マルチゾーンデータに対して強力な整合性が有効になっていません。

    ON
    ProxyCpuCores

    string

    データベースプロキシの CPU コア数。

    4
    ProxyStandardCpuCores

    string

    標準仕様のデータベースプロキシの CPU コア数。

    2
    ProxyType

    string

    データベースプロキシのタイプ。有効な値:

    • Exclusive: 専用 Enterprise Edition

    • General: 標準 Enterprise Edition

    Exclusive
    ProxyStatus

    string

    データベースプロキシのステータス。有効な値:

    • Creating

    • Running

    • Deleting: プロキシはリリース中です。

    • Rebooting

    • DBNodeCreating: ノードが追加されています。

    • DBNodeDeleting: ノードが削除されています。

    • ClassChanging: ノード仕様が変更されています。

    • NetAddressCreating: ネットワーク接続が作成されています。

    • NetAddressDeleting: ネットワーク接続が削除されています。

    • NetAddressModifying: ネットワーク接続が変更されています。

    • Deleted: プロキシはリリースされました。

    Running
    ProxyServerlessType

    string

    データベースプロキシのサーバーレスタイプ。有効な値:

    • AgileServerless: アジャイル。サーバーレスクラスターを示します。

    • 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: クラスターは、レベル 1 バックアップから特定の時点に復元されます。

    • RestoreByBackupSet: クラスターは、レベル 1 バックアップセットから復元されます。

    • RestoreByTimeOss: クラスターは、レベル 2 バックアップから特定の時点に復元されます。

    • RestoreByBackupSetOss: クラスターは、レベル 2 バックアップセットから復元されます。

    • 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

    自動 IMCI ベースのクエリアクセラレーション機能。有効な値:

    • ON: 有効。

    • OFF: 無効。

    OFF
    AutoUpgradeMinorVersion

    string

    マイナーバージョンのアップグレード方法。

    • Auto: 自動アップグレード

    • Manual: 手動アップグレード

    Manual
    BurstingEnabled

    string

    ESSD AutoPL ディスクでパフォーマンスバースト機能が有効になっているかどうかを示します。有効な値:

    • true: 有効

    • false: 無効

    false
    RowCompression

    string

    ImperceptibleSwitch

    string

    無感知スイッチオーバー機能。有効な値:

    • true: 有効。

    • false: 無効。

    StorageUsed

    integer

    使用済みストレージ容量。単位: バイト。

    3012558848
    CompressStorageUsed

    integer

    圧縮されたストレージデータのサイズ。

    説明

    このパラメーターは、クラスターでストレージ圧縮機能が有効になっている場合にのみ返されます。

    15529410560
    DBClusterStatus

    string

    クラスターのステータス。有効な値の詳細については、「クラスターの状態」をご参照ください。

    Running

    例

    成功レスポンス

    JSONJSON

    {
  "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": "",
      "MultiMasterPrimaryNode": "",
      "DBNodeDescription": "test",
      "SubGroupDescription": "",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": ""
    }
  ],
  "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": "",
  "VSwitchId": "vsw-*********************",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "SearchStorageUsed": 0,
  "SearchCompressStorageUsed": 0,
  "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": "",
  "ImperceptibleSwitch": "",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 15529410560,
  "DBClusterStatus": "Running"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。