この操作では、指定した ApsaraDB for PolarDB クラスターの詳細情報を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須 / 任意 例 説明
DBClusterId String 必須 pc-xxxxxxxxxxxxxxx

クラスターの ID。
AccessKeyId String 任意 key-test

Alibaba Cloud から提供される AccessKey ID 。
Action String 任意 DescribeDBClusterAttribute

実行する操作。 値を DescribeDBClusterAttribute に設定します。

レスポンスパラメーター

パラメーター データ型 例 説明
CreationTime String 2019-04-26T06:01:28Z

ホストが作成された時間。
DBClusterDescription String test

クラスターの説明。
DBClusterId String pc-xxxxxxxxxxxxxx

クラスターの ID。
DBClusterNetworkType String VPC

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

クラスターのステータス。

  • Creating
  • Running
  • Deleting
  • Rebooting
  • DBNodeCreating: ノードを作成中。
  • DBNodeDeleting: ノードを削除中。
  • ClassChanging: ノード仕様を変更中。
  • NetAddressCreating: ネットワーク接続を作成中。
  • NetAddressDeleting: ネットワーク接続を削除中。
  • NetAddressModifying: ネットワーク接続を変更中。
DBNodes Array

クラスター内のノードのリスト。
CreationTime String 2019-04-26T22:01:28Z

ノードが作成された時間。
DBNodeClass String polar.mysql.x2.medium

ノードの仕様。
DBNodeId String pi-xxxxxxxxxxxxxx

ノードの ID。
DBNodeRole String Writer

ノードのロール。 設定可能な値は以下のとおりです。

  • Writer
  • Reader
DBNodeStatus String Running

ノードのステータス。
FailoverPriority Integer 1

ノードのフェイルオーバーの優先度。
MaxConnections Integer 1200

ノードがサポートしている最大同時接続数。
MaxIOPS Integer 8000

1 秒あたりの I/O 操作の最大数 (IOPS)。
ZoneId String cn-qingdao-c

ゾーンの ID。
DBType String MySQL

データベースのエンジン。
DBVersion String 5.6

データベースのバージョン。
DeletionLock Integer 0

クラスター削除のロックモード。 設定可能な値は以下のとおりです。

  • 0: ロック解除。
  • 1: ロック中。 クラスターは削除できません。
Engine String PolarDB

クラスターのエンジン。
ExpireTime String 2019-09-14T16:00:00Z

クラスターの有効期限。

注 従量課金制のクラスターには有効期限がありません。
Expired String false

証明書の有効か期限切れであるか。
IsLatestVersion Boolean false

カーネルのバージョンが最新かどうか。
LockMode String Unlock

クラスターのロックモード。 設定可能な値は以下のとおりです。

  • Unlock: ロック解除されています。
  • ManualLock: インスタンスは手動でロックされています。
  • LockByExpiration: インスタンスの有効期限が切れると、インスタンスは自動的にロックされます。
MaintainTime String 18:00Z-19:00Z

クラスターのメンテナンス期間。 HH:mmZ-HH:mmZ の形で指定します。

たとえば、16:00Z-17:00Z と指定した場合、クラスターは 0 時から 1 時 (UTC+08:00) までメンテナンス可能であることを示します。

PayType String Postpaid

クラスターの課金方法。 設定可能な値は以下のとおりです。

  • Postpaid: 従量課金
  • Prepaid: サブスクリプション
RegionId String cn-hangzhou

クラスターが設置されているリージョンの ID。
RequestId String 4E148395-950A-46F8-BFF8-274A64CD793B

リクエストの ID。
SQLSize Long 0

SQL データが占領している総容量。 単位: バイト。 -1 は、容量が使用されていないことを示します。
StorageMax Long 5497558138880

現在のクラスター仕様でサポートされている最大ストレージ容量。 単位: バイト。
StorageUsed Long 3133145088

クラスターのストレージ使用量。 単位: バイト。
Tags Array

タグのセット。
Key String test1

タグのキー。
Value String 1111

タグの値。
VPCId String vpc-xxxxxxxxxxxxxx

クラスターの VPC ID。
VSwitchId String vsw-xxxxxxxxxxxxxx

クラスターの VSwitch ID。
ZoneIds String cn-hangzhou-i,cn-hangzhou-g

ゾーン。

例

リクエストの例


http(s)://[Endpoint]/? Action=DescribeDBClusterAttribute
&DBClusterId=pc-xxxxxxxxxxxxxxx
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<DBVersion>5.6</DBVersion>
<LockMode>Unlock</LockMode>
<DBClusterDescription>test</DBClusterDescription>
<DBClusterNetworkType>VPC</DBClusterNetworkType>
<DBClusterId>pc-xxxxxxxxxxxxxx</DBClusterId>
<VSwitchId>vsw-xxxxxxxxxxxxxx</VSwitchId>
<Engine>PolarDB</Engine>
<DBClusterStatus>Running</DBClusterStatus>
<CreationTime>2019-04-26T06:01:28Z</CreationTime>
<MaintainTime>18:00Z-19:00Z</MaintainTime>
<VPCId>vpc-xxxxxxxxxxxxxx</VPCId>
<ExpireTime/>
<Expired>false</Expired>
<RequestId>4E148395-950A-46F8-BFF8-274A64CD793B</RequestId>
<RegionId>cn-hangzhou</RegionId>
<DBType>MySQL</DBType>
<DBNodes>
    <CreationTime>2019-04-26T22:01:28Z</CreationTime>
    <MaxIOPS>8000</MaxIOPS>
    <DBNodeRole>Writer</DBNodeRole>
    <MaxConnections>1200</MaxConnections>
    <DBNodeClass>polar.mysql.x2.medium</DBNodeClass>
    <DBNodeStatus>Running</DBNodeStatus>
    <ZoneIds>cn-hangzhou-i,cn-hangzhou-g</ZoneIds>
    <DBNodeId>pi-xxxxxxxxxxxxxx</DBNodeId>
</DBNodes>
<DBNodes>
    <CreationTime>2019-04-26T22:01:28Z</CreationTime>
    <MaxIOPS>8000</MaxIOPS>
    <DBNodeRole>Reader</DBNodeRole>
    <MaxConnections>1200</MaxConnections>
    <DBNodeClass>polar.mysql.x2.medium</DBNodeClass>
    <DBNodeStatus>Running</DBNodeStatus>
    <ZoneIds>cn-hangzhou-i,cn-hangzhou-g</ZoneIds>
    <DBNodeId>pi-xxxxxxxxxxxxxx</DBNodeId>
</DBNodes>
<SQLSize>0</SQLSize>
<PayType>Postpaid</PayType>

JSON 形式 

{
	"DBVersion":"5.6",
	"LockMode":"Unlock",
	"DBClusterDescription":"test",
	"DBClusterNetworkType":"VPC",
	"DBClusterId":"pc-xxxxxxxxxxxxxx",
	"VSwitchId":"vsw-xxxxxxxxxxxxxx",
	"Engine":"PolarDB",
	"DBClusterStatus":"Running",
	"CreationTime":"2019-04-26T06:01:28Z",
	"MaintainTime":"18:00Z-19:00Z",
	"Tags":[],
	"VPCId":"vpc-xxxxxxxxxxxxxx",
	"ExpireTime":"",
	"RegionId":"cn-hangzhou",
	"RequestId":"4E148395-950A-46F8-BFF8-274A64CD793B",
	"Expired":false,
	"DBType":"MySQL",
	"SQLSize":0,
	"DBNodes":[
		{
			"CreationTime":"2019-04-26T22:01:28Z",
			"MaxIOPS":8000,
			"DBNodeRole":"Writer",
			"MaxConnections":1200,
			"DBNodeClass":"polar.mysql.x2.medium",
			"DBNodeStatus":"Running",
			"ZoneIds":"cn-hangzhou-i,cn-hangzhou-g",
			"DBNodeId":"pi-xxxxxxxxxxxxxx"
		},
		{
			"CreationTime":"2019-04-26T22:01:28Z",
			"MaxIOPS":8000,
			"DBNodeRole":"Reader",
			"MaxConnections":1200,
			"DBNodeClass":"polar.mysql.x2.medium",
			"DBNodeStatus":"Running",
			"ZoneIds":"cn-hangzhou-i,cn-hangzhou-g",
			"DBNodeId":"pi-xxxxxxxxxxxxxx"
		}
	],
	"PayType":"Postpaid"
}

エラーコード

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