DescribeDBClusterAttribute でクラスター属性をクエリ - PolarDB - Alibaba Cloud - PolarDB

クラスターの属性情報を照会します。

今すぐお試しください

この 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: Cluster Edition Basic: シングルノードエディション Archive: PolarDB X-Engine Edition NormalMultimaster: マルチマスター Cluster Edition SENormal: PolarDB for MySQL Standard Edition 説明 PolarDB for PostgreSQL 11 はシングルノードエディションをサポートしていません。 PolarDB for MySQL 8.0、PolarDB for MySQL 5.7、および PolarDB for PostgreSQL 14 は PolarDB for MySQL Standard Edition をサポートしています。 PolarDB for MySQL 8.0 は PolarDB X-Engine Edition およびマルチマスター Cluster Edition をサポートしています。	法線
ResourceGroupId	string	リソースグループの ID。	rg-***************
DataLevel1BackupChainSize	integer	レベル 1 バックアップ (スナップショット) の合計サイズ。単位: バイト。	74448896
DBClusterId	string	クラスターの ID。	pc-*****************
DBType	string	データベースエンジンのタイプ。	MySQL
DBClusterNetworkType	string	クラスターのネットワークタイプ。	VPC
IsLatestVersion	boolean	クラスターが最新のカーネルバージョンを実行しているかどうかを示します。有効な値:	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
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 秒あたりの I/O リクエスト数 (IOPS) の最大値。	32000
DBNodeClass	string	ノードスペック。	polar.mysql.x4.large
CpuCores	string	ノードの CPU コア数。	2
MemorySize	string	ノードのメモリサイズ。単位: MB。	8192
DBNodeRole	string	ノードのロール。有効な値:	Reader
ZoneId	string	ゾーンの ID。	cn-hangzhou-i
MaxConnections	integer	クラスターへの同時接続数の最大値。	8000
DBNodeStatus	string	ノードのステータス。有効な値:	Running
DBNodeId	string	ノードの ID。	pi-****************
ImciSwitch	string	インメモリー列指向インデックスが有効かどうかを示します。有効な値:	ON
HotReplicaMode	string	ホットスタンバイが有効かどうかを示します。有効な値:	ON
AddedCpuCores	string	ローカルリソースの自動スケーリングによって追加された CPU コア数。	6
MasterId	string	Multi-master Cluster エディションのプライマリノード ID。	pi-bp18z52akld3*****
SccMode	string	ノードに対してグローバル整合性 (高性能モード) 特徴が有効かどうかを示します。有効な値:	ON
ServerWeight	string	ルーティングの重み。	1
ServerlessType	string	ノードのサーバーレスタイプ。有効な値: AgileServerless: アジャイルサーバーレス。ノードはサーバーレスノードです。 SteadyServerless: ステディサーバーレス。ノードはサーバーレス機能が有効な固定仕様のノードです。説明このパラメーターは、サーバーレスクラスターまたはサーバーレス機能が有効な固定仕様のクラスターでのみサポートされています。詳細については、「 Serverless 」を参照してください。	SteadyServerless
SubCluster	string	ノードがプライマリゾーンまたはセカンダリゾーンのいずれにあるかを示します。このパラメーターは、主にリソース対称デプロイメントに使用されます。有効な値: Primary: プライマリゾーン。 Standby: セカンダリゾーン。	Primary
RemoteMemorySize	string	リモートメモリサイズ。単位: MB。	3072
Orca	string	Orca 特徴。有効な値:	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
DedicatedHostModel	boolean
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+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	VPC の ID。	vpc-*******************
SearchClusterStatus	string	検索ノードの実行中ステータス。	Running
VSwitchId	string	vSwitch の ID。	vsw-*********************
DBClusterDescription	string	クラスターの説明。	test
Expired	string	クラスターが期限切れかどうかを示します。	false
PayType	string	課金方法。有効な値:	Prepaid
StoragePayType	string	ストレージの課金方法。有効な値: Postpaid: 従量課金。 Prepaid: サブスクリプション。	Prepaid
LockMode	string	ロックモード。有効な値:	Unlock
SearchStorageUsed	integer	検索ノードのストレージ使用量。	3012558848
SearchCompressStorageUsed	integer	検索ノードの圧縮済みストレージデータサイズ。	15529410560
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	ファイルシステム内のノードの最大値。	6,291,456
InodeUsed	integer	現在のノード使用量。	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 for MySQL Cluster Edition クラスターの場合にのみ返されます。	排他的
IsProxyLatestVersion	boolean	データベースプロキシが最新バージョンかどうかを示します。有効な値:	false
StorageType	string	ストレージタイプ。値は HighPerformance に固定されています。	HighPerformance
ServerlessType	string	クラスターのサーバーレスタイプ。有効な値: AgileServerless: アジャイルサーバーレス。この値はサーバーレスクラスターを示します。 SteadyServerless: ステディサーバーレス。この値はサーバーレス機能が有効な固定仕様のクラスターを示します。説明このパラメーターは、サーバーレスクラスターまたはサーバーレス機能が有効な固定仕様のクラスターでのみサポートされています。	SteadyServerless
StrictConsistency	string	クラスターに対してマルチゾーンの強力なデータ整合性が有効かどうかを示します。有効な値:	ON
ProxyCpuCores	string	データベースプロキシの CPU コア数。	4
ProxyStandardCpuCores	string	データベースプロキシの標準構成における CPU コア数。	2
ProxyType	string	データベースプロキシのタイプ。有効な値:	排他的
ProxyStatus	string	データベースプロキシのステータス。有効な値:	Running
ProxyServerlessType	string	データベースプロキシのサーバーレスタイプ。有効な値: AgileServerless: アジャイルサーバーレス。サーバーレスクラスターを示します。 SteadyServerless: ステディサーバーレス。固定仕様のクラスター (サブスクリプションまたは従量課金クラスター) を示します。	SteadyServerless
Architecture	string	CPU アーキテクチャ。有効な値:	X86
AiType	string	AI ノードタイプ。有効な値:	DLNode
ProvisionedIops	string		2500
AiCreatingTime	string	無料 AI 特徴の開始時刻。	2024-03-13T01:20:28Z
SupportInstantSwitchWithImci	string	インメモリー列指向インデックス互換のホットレプリカによるフェールオーバー特徴がサポートされているかどうかを示します。	ON
Orca	string	Orca 特徴。有効な値:	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。	cn-beijing
ImciAutoIndex	string	インメモリー列指向インデックスベースの自動クエリ高速化特徴。有効な値:	OFF
AutoUpgradeMinorVersion	string	マイナーバージョンの更新ポリシー。	Manual
BurstingEnabled	string	ESSD AutoPL クラウドディスクの I/O パフォーマンスバースト機能が有効かどうかを示します。有効な値:	false
RowCompression	string	行圧縮設定。	OFF
ImperceptibleSwitch	string	ホットレプリカによるフェールオーバー特徴。有効な値:	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	接続リソースクォータ (AgenticDB 専用)。
ConnectionResourceUsed	integer	使用中の接続リソース数 (AgenticDB 専用)。
StorageUpperBound	integer
StorageAutoScale	string

例

成功レスポンス

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": "pi-****************",
      "MultiMasterPrimaryNode": "pi-****************",
      "DBNodeDescription": "test",
      "SubGroupDescription": "test Description",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "DBNodeCXLRemoteMemory": "3072",
      "RemoteMemoryMin": 0,
      "RemoteMemoryMax": 0,
      "RemoteMemoryRecommended": 0,
      "DedicatedHostModel": false
    }
  ],
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
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 が存在しません。

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

変更履歴

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