DescribeDBClusters - PolarDB - Alibaba Cloud ドキュメントセンター

この操作を呼び出すと、アカウントにある Apsara PolarDB クラスターを照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	データ型	必須項目	例	説明
Action	String	いいえ	DescribeDBClusters	実行する操作。値を DescribeDBClusters に設定します。
RegionId	String	はい	cn-hangzhou	Apsara PolarDB クラスターのリージョン ID。説明 DescribeRegions を呼び出すと、最新のリージョンリストを照会できます。
DBClusterIds	String	いいえ	pc-xxxxxxxxxxxxxxxxx	クラスターの ID。複数のクラスター ID を指定し、それをコンマ (,) で区切ることができます。
DBClusterDescription	String	いいえ	pc-xxxxxxxxxxxxxxxxx	クラスターの説明。説明のキーワードを指定して、クラスターをフィルターすることができます。
DBClusterStatus	String	いいえ	Running	クラスターのステータス。設定可能な値は以下のとおりです。 Creating: クラスター作成中。 Running: クラスター実行中。 Deleting: クラスター削除中。 Rebooting: クラスター再起動中。 DBNodeCreating: クラスターにノードを追加中。 DBNodeDeleting: クラスターからノードを削除中。 ClassChanging: ノードの仕様を更新中。 NetAddressCreating: ネットワーク接続を作成中。 NetAddressDeleting: ネットワーク接続を削除中。 NetAddressModifying: ネットワーク接続を変更中。
DBType	String	いいえ	MySQL	データベースのエンジン。設定可能な値は以下のとおりです。 MySQL PostgreSQL Oracle
Tag.N.Key	String	いいえ	test1	クラスターのフィルター条件として使用できるタグのキー。タグはキーと値のペアです。 1 回のリクエストで最大 20 個のタグを指定できます。文字 N は各キーと値のペアのシーケンス番号を指定し、一意なものである必要があります。 N の値は、1 から始まる連続した整数でなければなりません。 Tag.N.Key パラメーターの各値は、Tag.N.Value パラメーターの値とペアになります。説明キーの長さは最大 64 文字で、`aliyun、acs:、http:// または https://` で始めることはできません。
Tag.N.Value	String	いいえ	1111	クラスターのフィルター条件として使用できるタグの値。タグはキーと値のペアです。 1 回のリクエストで最大 20 個のタグを指定できます。文字 N は各キーと値のペアのシーケンス番号を指定し、一意なものである必要があります。 N の値は、1 から始まる連続した整数でなければなりません。 Tag.N.Value パラメーターの各値は、Tag.N.Key パラメーターの値とペアになります。説明 Tag.N.Key パラメーターを指定する場合は、Tag.N.Value パラメーターも指定する必要があります。値の長さは最大 64 文字で、`aliyun、acs:、http:// または https://` で始めることはできません。
PageSize	Integer	いいえ	30	返される各ページのエントリ数。有効値: 30、50、100。デフォルト値: 30。
PageNumber	Integer	いいえ	1	返されるページの番号。ページは 1 ページ目から始まります。デフォルト値: 1。
ResourceGroupId	String	いいえ	rg-rexxxxxxxxxx	リソースグループの ID。

応答パラメーター

パラメーター	データ型	例	説明
RequestId	String	F7036AE7-20B7-43F8-9E58-558CCDED8CCB	リクエストの ID。
PageNumber	Integer	1	返されたページのページ番号。
TotalRecordCount	Integer	1	返されたレコードの総数。
PageRecordCount	Integer	1	ページにあるクラスターの数。
Items	Array		返されたクラスターのリスト。
DBClusterId	String	pc-xxxxxxxxxxxxxxxxx	PolarDB クラスターの ID。
DBClusterDescription	String	pc-xxxxxxxxxxxxxxxxx	PolarDB クラスターの説明。
PayType	String	Postpaid	課金方法。設定可能な値は以下のとおりです。 Postpaid: 従量課金 Prepaid: サブスクリプション
DBClusterNetworkType	String	VPC	クラスターのネットワークタイプ。
RegionId	String	cn-hangzhou	クラスターのリージョン ID。
ZoneId	String	cn-hangzhou-g	クラスターのゾーン ID。
ExpireTime	String	2020-01-10T09:33:58Z	クラスターの有効期限。
Expired	String	false	クラスターが有効か期限切れかを示します。
DBClusterStatus	String	Running	クラスターのステータス。
Engine	String	POLARDB	クラスターのエンジン。
DBType	String	MySQL	データベースのエンジン。
DBVersion	String	5.6	データベースエンジンのバージョン。
LockMode	String	Unlock	クラスターのロックモード。設定可能な値は以下のとおりです。 Unlock: インスタンスはロックされていません。 ManualLock: クラスターは手動ロックされています。 LockByExpiration: 有効期限が切れると、クラスターは自動的にロックされます。
DeletionLock	Integer	0	クラスターの削除保護機能のステータス。設定可能な値は以下のとおりです。 0: 無効。 1: 有効。削除保護が有効になっていると、クラスターを削除できません。
CreateTime	String	2019-01-10T09:33:58Z	クラスターが作成された時刻。
VpcId	String	vpc-xxxxxxxxxxxxxxxxx	クラスターがデプロイされている VPC ネットワークの ID。
DBNodeNumber	Integer	2	クラスター内のノード数。
DBNodeClass	String	polar.mysql.x4.large	ノードの仕様。
StorageUsed	Long	3150970880	クラスターのストレージ使用率。
ResourceGroupId	String	rg-rexxxxxxxxxx	リソースグループの ID。
DBNodes	Array		クラスター内のノードのリスト。
DBNodeId	String	pi-xxxxxxxxxxxxxxxxx	ノードの ID。
DBNodeClass	String	polar.mysql.x4.large	ノードの仕様。
DBNodeRole	String	Writer	ノードのロール。設定可能な値は以下のとおりです。 Writer Reader
RegionId	String	cn-hangzhou	ノードのリージョン ID。
ZoneId	String	cn-hangzhou-g	ノードのゾーン ID。
Tags	Array		クラスターにアタッチされているタグのリスト。
Key	String	test1	タグのキー。
Value	String	1111	タグの値。

例

リクエストの例

http(s)://[Endpoint]/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

正常なレスポンスの例

XML 形式

<DescribeDBClustersResponse>  
      <Items>
            <DBCluster>
                  <DBVersion>5.6</DBVersion>
                  <LockMode>Unlock</LockMode>
                  <DBClusterDescription>pc-xxxxxxxxxxxxxxxxx</DBClusterDescription>
                  <DBClusterNetworkType>VPC</DBClusterNetworkType>
                  <StorageUsed>3150970880</StorageUsed>
                  <ZoneId>cn-hangzhou-g</ZoneId>
                  <DBClusterId>pc-xxxxxxxxxxxxxxxxx</DBClusterId>
                  <VpcId>vpc-xxxxxxxxxxxxxxxxx</VpcId>
                  <Engine>POLARDB</Engine>
                  <DBClusterStatus>Running</DBClusterStatus>
                  <Tags>
                        <Tag>
                              <Value>1111</Value>
                              <Key>test1</Key>
                        </Tag>
                        <Tag>
                              <Value>2222</Value>
                              <Key>test2</Key>
                        </Tag>
                  </Tags>
                  <ExpireTime></ExpireTime>
                  <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
                  <RegionId>cn-hangzhou</RegionId>
                  <Expired>false</Expired>
                  <CreateTime>2019-01-10T09:33:58Z</CreateTime>
                  <DBType>MySQL</DBType>
                  <DBNodes>
                        <DBNode>
                              <DBNodeRole>Writer</DBNodeRole>
                              <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
                              <DBNodeId>pi-xxxxxxxxxxxxxxxxx</DBNodeId>
                        </DBNode>
                        <DBNode>
                              <DBNodeRole>Reader</DBNodeRole>
                              <DBNodeClass>polar.mysql.x4.large</DBNodeClass>
                              <DBNodeId>pi-xxxxxxxxxxxxxxxxx</DBNodeId>
                        </DBNode>
                  </DBNodes>
                  <DBNodeNumber>2</DBNodeNumber>
                  <PayType>Postpaid</PayType>
            </DBCluster>
      </Items>
      <TotalRecordCount>1</TotalRecordCount>
      <PageNumber>1</PageNumber>
      <RequestId>F7036AE7-20B7-43F8-9E58-558CCDED8CCB</RequestId>
      <PageRecordCount>1</PageRecordCount>
  </DescribeDBClustersResponse>

JSON 形式

{
    "Items": {
        "DBCluster": [
            {
                "DBVersion": "5.6",
                "LockMode": "Unlock",
                "DBClusterDescription": "pc-xxxxxxxxxxxxxxxxx",
                "DBClusterNetworkType": "VPC",
                "StorageUsed": 3150970880,
                "ZoneId": "cn-hangzhou-g",
                "DBClusterId": "pc-xxxxxxxxxxxxxxxxx",
                "VpcId": "vpc-xxxxxxxxxxxxxxxxx",
                "Engine": "POLARDB",
                "DBClusterStatus": "Running",
                "Tags": {
                    "Tag": [
                        {
                            "Value": "1111",
                            "Key": "test1"
                        },
                        {
                            "Value": "2222",
                            "Key": "test2"
                        }
                    ]
                },
                "ExpireTime": "",
                "DBNodeClass": "polar.mysql.x4.large",
                "RegionId": "cn-hangzhou",
                "Expired": false,
                "CreateTime": "2019-01-10T09:33:58Z",
                "DBType": "MySQL",
                "DBNodes": {
                    "DBNode": [
                        {
                            "DBNodeRole": "Writer",
                            "DBNodeClass": "polar.mysql.x4.large",
                            "DBNodeId": "pi-xxxxxxxxxxxxxxxxx"
                        },
                        {
                            "DBNodeRole": "Reader",
                            "DBNodeClass": "polar.mysql.x4.large",
                            "DBNodeId": "pi-xxxxxxxxxxxxxxxxx"
                        }
                    ]
                },
                "DBNodeNumber": "2",
                "PayType": "Postpaid"
            }
        ]
    },
    "TotalRecordCount": 1,
    "PageNumber": 1,
    "RequestId": "F7036AE7-20B7-43F8-9E58-558CCDED8CCB",
    "PageRecordCount":1
}

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。