ENS 上の PolarDB の DescribeDbClusterAttribute API リファレンス - 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:DescribeDbClusterAttributeZonal

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター 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 クラスターは、シングルノードエディションをサポートしていません。 8.0 および 5.7 の PolarDB for MySQL クラスター、および PostgreSQL 14 の PolarDB for PostgreSQL クラスターは、Standard Edition をサポートしています。 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
DBNodeStatus	string	ノードのステータス。有効な値: Creating: ノードは作成中です。 Running: ノードは実行中です。 Deleting: ノードは削除中です。 Rebooting: ノードは再起動中です。 DBNodeCreating: ノードを追加しています。 DBNodeDeleting: ノードを削除しています。 ClassChanging: ノード仕様を変更しています。 NetAddressCreating: ネットワーク接続を作成しています。 NetAddressDeleting: ネットワーク接続を削除しています。 NetAddressModifying: ネットワーク接続を変更しています。 MinorVersionUpgrading: マイナーバージョンを更新しています。 Maintaining: インスタンスはメンテナンス中です。 Switching: フェールオーバーが進行中です。	Running
SubGroupDescription	string	SubGroupDescription	SubGroupDescription
AddedCpuCores	string	バースト用の CPU コア数。	6
Orca	string	Orca 機能。有効な値: on: 有効 off: 無効	off
DBNodeRole	string	ノードのロール。有効な値: Writer: プライマリノード。 Reader: 読み取り専用ノード。	Reader
SubCluster	string	ノードがプライマリゾーンにあるかセカンダリゾーンにあるかを示します。このパラメーターは、主にリソースピアリングに使用されます。有効な値: Primary: プライマリゾーン Standby: セカンダリゾーン	Primary
ImciSwitch	string	インメモリ列インデックス (IMCI) 機能が有効になっているかどうかを示します。有効な値: ON: 有効 OFF: 無効	ON
DBNodeId	string	ノード ID。	pi-****************
RemoteMemorySize	string	リモートメモリのサイズ。単位: MB。	3072
MultiMasterLocalStandby	string	MultiMasterLocalStandby	MultiMasterLocalStandby
MultiMasterPrimaryNode	string	MultiMasterPrimaryNode	MultiMasterPrimaryNode
SccMode	string	ノードでグローバル整合性 (パフォーマンス専有型モード) 機能が有効になっているかどうかを示します。有効な値: ON: 有効 OFF: 無効	ON
FailoverPriority	integer	フェイルオーバーの優先度。各ノードにはフェイルオーバーの優先度があります。優先度の値が高いほど、フェイルオーバー中にノードがプライマリノードとして選出される可能性が高くなります。有効な値: 1～15。	1
ServerWeight	string	ルーティングの重み。有効な値: 1～100。デフォルト値: 1。	1
DBNodeDescription	string	ノードの説明。	test
MemorySize	string	ノードのメモリサイズ。単位: MB。	8192
MirrorInsName	string	ホットスタンバイストレージとホットスタンバイ計算が有効になっているアーキテクチャで、ノードに対応するホットレプリカ計算ノードの名前。	pi-bp18z52mirror*****
ZoneId	string	ゾーン ID。	cn-hangzhou-d
MaxConnections	integer	クラスターへの最大同時接続数。	8000
MaxIOPS	integer	1 秒あたりの最大入出力操作数 (IOPS)。	32000
DBNodeClass	string	ノード仕様。	polar.mysql.x4.large
ServerlessType	string	Serverless タイプ。有効な値: AgileServerless: アジャイル SteadyServerless: ステディ	AgileServerless
CreationTime	string	クラスターが作成された時間。	2020-08-14T05:58:42Z
CpuCores	string	ノードの CPU コア数。	2
MasterId	string	Multi-master Cluster Edition クラスターのプライマリノードの ID。	pi-bp18z52akld3*****
HotReplicaMode	string	ホットスタンバイが有効になっているかどうかを示します。有効な値: ON: 有効 OFF: 無効	ON
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
Value	string	タグ値。	MySQL
Key	string	タグキー。	test
RequestId	string	リクエスト ID。	074467EF-86B9-4C23-ACBF-E9B81A******
VPCId	string	VPC (Virtual Private Cloud) ID。	vpc-**********
DBClusterStatus	string	クラスターのステータス。有効な値: Creating: クラスターは作成中です。 Running: クラスターは実行中です。 Deleting: クラスターはリリース中です。 Rebooting: クラスターは再起動中です。 DBNodeCreating: ノードを追加しています。 DBNodeDeleting: ノードを削除しています。 ClassChanging: ノード仕様を変更しています。 NetAddressCreating: ネットワーク接続を作成しています。 NetAddressDeleting: ネットワーク接続を削除しています。 NetAddressModifying: ネットワーク接続を変更しています。 Deleted: クラスターはリリースされました。 ClassChanged: スペックアップまたはスペックダウン後にリソースを再利用しています。	Running
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
StorageUsed	integer	使用済みストレージ容量。単位: バイト。	3012558848
CompressStorageUsed	integer	ストレージ内の圧縮データのサイズ。説明このパラメーターは、クラスターでストレージ圧縮が有効になっている場合にのみ返されます。	15529410560
StorageSpace	integer	ストレージ容量。単位: GB。	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	クラスターの有効期限。説明このパラメーターは、Prepaid (サブスクリプション) クラスターに対してのみ返されます。Postpaid (従量課金) クラスターの場合は空の値が返されます。	2020-11-14T16:00:00Z
SubCategory	string	計算ノードの仕様タイプ。有効な値: Exclusive: 専用 General: 汎用説明このパラメーターは、PolarDB for MySQL クラスター版クラスターに対してのみ返されます。	Exclusive
IsProxyLatestVersion	boolean	データベースプロキシが最新バージョンを使用しているかどうかを示します。有効な値: true: はい false: いいえ	false
StorageType	string	Enterprise Edition のストレージタイプ。有効な値: PSL5 PSL4 Standard Edition のストレージタイプ。有効な値: ESSDPL0 ESSDPL1 ESSDPL2 ESSDPL3 ESSDAUTOPL	ESSDPL0
ServerlessType	string	Serverless タイプ。有効な値: AgileServerless: アジャイル SteadyServerless: ステディ	AgileServerless
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	データベースプロキシの Serverless タイプ。有効な値: AgileServerless: アジャイル。これは Serverless クラスターを示します。 SteadyServerless: ステディ。これは、定義された仕様を持つクラスター (サブスクリプションまたは従量課金クラスター) を示します。	SteadyServerless
Architecture	string	CPU アーキテクチャ。有効な値: X86 ARM	x86
AiType	string	AI ノードタイプ。有効な値: SearchNode: 検索ノード。 DLNode: AI ノード。	DLNode
ProvisionedIops	string		1000
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: 手動アップグレード	Auto
BurstingEnabled	string	ESSD AutoPL ディスクで I/O パフォーマンスバースト機能が有効になっているかどうかを示します。有効な値: true: 有効 false: 無効	false
RowCompression	string	RowCompression	OFF
ImperceptibleSwitch	string	ホットレプリカによるフェイルオーバー。有効な値: `true`: 有効。 `false`: 無効。	False
DBClusterClass	string	クラスター仕様。	polar.mysql.x8.medium.c

例

成功レスポンス

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": [
    {
      "DBNodeStatus": "Running",
      "SubGroupDescription": "SubGroupDescription",
      "AddedCpuCores": "6",
      "Orca": "off",
      "DBNodeRole": "Reader",
      "SubCluster": "Primary",
      "ImciSwitch": "ON",
      "DBNodeId": "pi-****************",
      "RemoteMemorySize": "3072",
      "MultiMasterLocalStandby": "MultiMasterLocalStandby",
      "MultiMasterPrimaryNode": "MultiMasterPrimaryNode",
      "SccMode": "ON",
      "FailoverPriority": 1,
      "ServerWeight": "1",
      "DBNodeDescription": "test",
      "MemorySize": "8192",
      "MirrorInsName": "pi-bp18z52mirror*****",
      "ZoneId": "cn-hangzhou-d\t\n",
      "MaxConnections": 8000,
      "MaxIOPS": 32000,
      "DBNodeClass": "polar.mysql.x4.large",
      "ServerlessType": "AgileServerless",
      "CreationTime": "2020-08-14T05:58:42Z",
      "CpuCores": "2",
      "MasterId": "pi-bp18z52akld3*****",
      "HotReplicaMode": "ON"
    }
  ],
  "ZoneIds": "cn-hangzhou-i,cn-hangzhou-g",
  "MaintainTime": "18:00Z-19:00Z",
  "Engine": "POLARDB",
  "Tags": [
    {
      "Value": "MySQL",
      "Key": "test"
    }
  ],
  "RequestId": "074467EF-86B9-4C23-ACBF-E9B81A******",
  "VPCId": "vpc-**********",
  "DBClusterStatus": "Running",
  "VSwitchId": "vsw-**********",
  "DBClusterDescription": "test",
  "Expired": "false",
  "PayType": "Prepaid",
  "StoragePayType": "Prepaid",
  "LockMode": "Unlock",
  "StorageUsed": 3012558848,
  "CompressStorageUsed": 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": "ESSDPL0",
  "ServerlessType": "AgileServerless",
  "StrictConsistency": "ON",
  "ProxyCpuCores": "4",
  "ProxyStandardCpuCores": "2",
  "ProxyType": "Exclusive",
  "ProxyStatus": "Running",
  "ProxyServerlessType": "SteadyServerless",
  "Architecture": "x86",
  "AiType": "DLNode",
  "ProvisionedIops": "1000",
  "AiCreatingTime": "2024-03-13T01:20:28Z",
  "SupportInstantSwitchWithImci": "ON",
  "Orca": "ON",
  "SourceDBCluster": "pc-pz51ziv48317b2880",
  "RestoreType": "RestoreByTime",
  "RestoreDataPoint": "2179639137",
  "SourceRegionId": "cn-beijing",
  "ImciAutoIndex": "OFF",
  "AutoUpgradeMinorVersion": "Auto",
  "BurstingEnabled": "false",
  "RowCompression": "OFF",
  "ImperceptibleSwitch": "False",
  "DBClusterClass": "polar.mysql.x8.medium.c"
}

エラーコード

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.

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

変更履歴

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