DescribeDBClusters API でクラスター詳細をクエリ - PolarDB - Alibaba Cloud - PolarDB

PolarDB クラスターまたは RAM 認可によって権限付与されたクラスターの詳細を照会します。

今すぐお試しください

この 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:DescribeDBClusters

list

*DBCluster。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。説明 DescribeRegions 操作を呼び出して、利用可能なリージョンをクエリできます。	cn-hangzhou
DBClusterIds	string	任意	クラスター ID。複数のクラスター ID はコンマ（,）で区切ります。	pc-****************
DBClusterDescription	string	任意	クラスターの説明。あいまい一致がサポートされています。	pc-****************
ConnectionString	string	任意	データベースエンドポイント。	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	任意	クラスターのステータス。有効な値については、クラスターステータステーブルを参照してください。	Running
DBType	string	任意	データベースタイプ。有効な値: MySQL PostgreSQL Oracle	MySQL
DescribeType	string	任意	リストのクエリモード。値を Simple に設定すると、シンプルモードが使用され、クラスターの基本メタデータのみが返されます。説明このパラメーターを指定しない場合、デフォルトで詳細モードが使用され、クラスターの詳細情報が返されます。	Simple
DBVersion	string	任意	データベースエンジンのバージョン。	5.6
RecentCreationInterval	integer	任意	過去 N 日以内に作成されたクラスターをフィルターします。有効な値: 0～15。	7
RecentExpirationInterval	integer	任意	今後 N 日以内に有効期限切れになるクラスターをフィルターします。有効な値: 0～15。	6
Expired	boolean	任意	クラスターが有効期限切れかどうかを指定します。有効な値: true false	true
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 30、50、100。デフォルト値: 30。	30
PageNumber	integer	任意	ページ番号。値は Integer データの型の最大値を超えない正の整数である必要があります。デフォルト値: 1。	10
ResourceGroupId	string	任意	リソースグループ ID。	rg-**********
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	タグキー。タグを使用してクラスターリストをフィルターできます。最大 20 個のタグペアを指定できます。各タグペアの番号 n は一意であり、1 から始まる連続した整数である必要があります。Tag.n.Key パラメーターは Tag.n.Value パラメーターとペアになっています。説明タグキーは最大 64 文字で、`aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。	MySQL
Value	string	任意	タグキーに対応するタグ値。説明タグ値は最大 64 文字で、`aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。	5.6
PayType	string	任意	課金方法。有効な値: Postpaid: 従量課金。 Prepaid: サブスクリプション。	Postpaid
DBNodeIds	string	任意	ノード ID。複数のノード ID はコンマ（,）で区切って指定できます。	pi-***************

レスポンスフィールド

フィールド	型	説明	例
	object
TotalRecordCount	integer	レコードの総数。	16
PageRecordCount	integer	現在のページのクラスター数。	5
RequestId	string	リクエスト ID。	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	ページ番号。	12
Items	object
DBCluster	array<object>	クラスターリスト。
	array<object>
VpcId	string	VPC ID。	vpc-****************
VswitchId	string	VSwitch ID。	vsw-***************
ExpireTime	string	クラスターの有効期限。説明このパラメーターは、Prepaid (サブスクリプション) クラスターに対してのみ返されます。Postpaid (従量課金) クラスターの場合、空の文字列が返されます。	2020-11-14T16:00:00Z
Expired	string	クラスターが期限切れかどうかを示します。有効な値： true false 説明このパラメーターは、Prepaid (サブスクリプション) クラスターに対してのみ返されます。	false
DBNodeNumber	integer	ノード数。	2
CreateTime	string	クラスターが作成された時間。	2020-08-14T05:58:42Z
PayType	string	課金方法。有効な値： Postpaid：従量課金。 Prepaid：サブスクリプション。	Prepaid
StoragePayType	string	ストレージの課金方法。有効な値： Postpaid：従量課金 (容量単位の課金)。 Prepaid：サブスクリプション (スペース単位の課金)。	Prepaid
ServerlessType	string	サーバーレスタイプ。値 AgileServerless はサーバーレスクラスターを示します。空の文字列は通常のクラスターを示します。	AgileServerless
StrictConsistency	string	クラスターでマルチゾーンの強力な整合性が有効になっているかどうかを示します。有効な値： ON：マルチゾーンの強力な整合性が有効になっています。これは、3 つのゾーンにデプロイされている Standard Edition クラスターに適用されます。 OFF：マルチゾーンの強力な整合性は無効です。	ON
DBNodeClass	string	ノード仕様。	polar.mysql.x4.large
Tags	object	クラスターのタグ。
Tag	array<object>	タグのリスト。
	object
Key	string	タグキー。	MySQL
Value	string	タグ値。	5.6
DBType	string	データベースタイプ。	MySQL
LockMode	string	クラスターのロックモード。有効な値： Unlock：クラスターはロックされていません。 ManualLock：クラスターは手動でロックされています。 LockByExpiration：クラスターは期限切れ後に自動的にロックされます。	Unlock
DBNodes	object	クラスター内のノードの詳細。
DBNode	array<object>	ノードのリスト。
	object
DBNodeClass	string	ノード仕様。	polar.mysql.x4.large
ZoneId	string	ゾーン ID。	cn-hangzhou-i
DBNodeRole	string	ノードのロール。有効な値： Writer：プライマリノード。 Reader：読み取り専用ノード。 ColumnReader：列ストア読み取り専用ノード。 AI：AI ノード。	Reader
DBNodeId	string	ノード ID。	pi-****************
RegionId	string	リージョン ID。	cn-hangzhou
Serverless	string	ノードでサーバーレス機能が有効になっているかどうかを示します。値 ON は、機能が有効になっていることを示します。空の文字列は、無効になっていることを示します。	ON
ImciSwitch	string	列ストアインデックス機能が有効になっているかどうかを示します。有効な値： ON：有効 OFF：無効	OFF
HotReplicaMode	string	ホットスタンバイ機能が有効になっているかどうかを示します。有効な値： ON：有効 OFF：無効	OFF
RegionId	string	リージョン ID。	cn-hangzhou
DeletionLock	integer	クラスターの削除ロックステータス。有効な値： 0：ロック解除済み。 1：ロック済み。説明ロックされたクラスターは削除できません。	0
DBVersion	string	データベースバージョン。	5.6
DBClusterId	string	クラスター ID。	pc-****************
DBClusterStatus	string	クラスターのステータス。	Running
ResourceGroupId	string	リソースグループ ID。	rg-************
SearchStorageUsed	integer	検索ノードのストレージ使用量。	89227945573
StorageSpace	integer	サブスクリプションクラスターのストレージ容量。単位：バイト。	50
DBClusterNetworkType	string	クラスターのネットワークタイプ。	VPC
DBClusterDescription	string	クラスターの説明。	GDN-1
ZoneId	string	ゾーン ID。	cn-hangzhou-i
Engine	string	データベースエンジン。	POLARDB
Category	string	クラスターのエディション。有効な値： Normal：クラスター版 Basic：シングルノード版 Archive：X-Engine 版 NormalMultimaster：マルチマスタークラスター (データベース/テーブル) 版	Normal
AiType	string	AI ノードのタイプ。有効な値： SearchNode：クラスターに検索ノードが含まれています。 DLNode：クラスターに AI ノードが含まれています。列挙値: SearchNode\|DLNode : 両方 DLNode : DLNode SearchNode : SearchNode	SearchNode
CpuCores	string	CPU コア数。	1
MemorySize	string	ノードのメモリサイズ。単位：MB。	2048
StorageType	string	Enterprise Edition クラスターのストレージタイプ。有効な値： HighPerformance：PL5 Standard：PL4 Standard Edition クラスターのストレージタイプ。有効な値： essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	ストレージホットスタンバイが有効になっているかどうかを示します。有効な値： ON：有効 OFF：無効	OFF
SubCategory	string	コンピュートノードの仕様タイプ。有効な値： Exclusive：専用仕様 General：汎用仕様	Exclusive
StorageUsed	integer	使用されているストレージ容量。単位：バイト。	3009413120
RemoteMemorySize	string	リモートメモリサイズ。単位：MB。	3612
ConnectionResourceQuota	integer
ConnectionResourceUsed	integer

例

成功レスポンス

JSONJSON

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": {
    "DBCluster": [
      {
        "VpcId": "vpc-****************",
        "VswitchId": "vsw-***************",
        "ExpireTime": "2020-11-14T16:00:00Z",
        "Expired": "false",
        "DBNodeNumber": 2,
        "CreateTime": "2020-08-14T05:58:42Z",
        "PayType": "Prepaid",
        "StoragePayType": "Prepaid",
        "ServerlessType": "AgileServerless",
        "StrictConsistency": "ON",
        "DBNodeClass": "polar.mysql.x4.large",
        "Tags": {
          "Tag": [
            {
              "Key": "MySQL",
              "Value": "5.6"
            }
          ]
        },
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "DBNodes": {
          "DBNode": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "ZoneId": "cn-hangzhou-i",
              "DBNodeRole": "Reader",
              "DBNodeId": "pi-****************",
              "RegionId": "cn-hangzhou",
              "Serverless": "ON",
              "ImciSwitch": "OFF",
              "HotReplicaMode": "OFF"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "5.6",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-************",
        "SearchStorageUsed": 89227945573,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode",
        "CpuCores": "1",
        "MemorySize": "2048",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF",
        "SubCategory": "Exclusive",
        "StorageUsed": 3009413120,
        "RemoteMemorySize": "3612",
        "ConnectionResourceQuota": 0,
        "ConnectionResourceUsed": 0
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	指定された Region。
400	NumberExceed.Tags	The Tags parameter's number is exceed.	tags パラメーターの数が上限を超えています。
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定されたパラメーター PageSize が無効です。
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定されたパラメーター PageNumber が無効です。
400	InvalidRecentCreationInterval.Malformed	The specified parameter RecentCreationInterval is not valid.	指定された RecentCreationInterval パラメーターが無効です。
400	InvalidRecentExpirationInterval.Malformed	The specified parameter RecentExpirationInterval is not valid.	指定された RecentExpirationInterval パラメーターが無効です。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	不明なエラー、例外、または障害によりリクエスト処理が失敗しました。
404	DBTypeOrDBVersion.Malformed	The specified DBType does not match DBVersion.	指定された DBType が DBVersion と一致しません。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	一時的なサーバー障害によりリクエストが失敗しました。

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

変更履歴

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