バックアップセットを持つリージョン内の PolarDB クラスターの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:DescribeDBClustersWithBackups |
get |
*DBCluster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-************ |
| RegionId |
string |
必須 |
リージョン ID。 説明
リージョンの詳細については、DescribeRegions 操作をご参照ください。 |
cn-hangzhou |
| DBClusterIds |
string |
任意 |
クラスターの ID。複数のクラスター ID を指定できます。ID はコンマ (,) で区切ります。 |
pc-************** |
| DBClusterDescription |
string |
任意 |
クラスター名。クラスター名は、次の要件を満たす必要があります：
|
test |
| DBType |
string |
任意 |
データベースエンジンのタイプ。有効な値：
|
MySQL |
| IsDeleted |
integer |
任意 |
クラスターが削除されたかどうかを指定します。有効な値：
|
0 |
| PageSize |
integer |
任意 |
各ページに表示されるレコード数。有効な値：
デフォルト値：30。 |
30 |
| PageNumber |
integer |
任意 |
ページ番号。値は 0 より大きい整数で、Integer データ型の最大値を超えないようにする必要があります。デフォルト値：1。 |
1 |
| DBVersion |
string |
任意 |
データベースエンジンのバージョン。
|
8.0 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
F8529AA2-522F-4B30-B80B-8F7D39****** |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageRecordCount |
integer |
現在のページにあるクラスターの数。 |
1 |
| TotalRecordCount |
integer |
返されたエントリの総数。 |
1 |
| Items |
object |
||
| DBCluster |
array<object> |
クラスターの詳細。 |
|
|
object |
|||
| DeletedTime |
string |
クラスターが削除された時間。 |
2022-05-12T03:25:37Z |
| VpcId |
string |
Virtual Private Cloud (VPC) の ID。 |
vpc-****************** |
| ExpireTime |
string |
有効期限。 説明
このパラメーターは、サブスクリプションクラスターに対してのみ返されます。従量課金クラスターの場合は、空の文字列が返されます。 |
2022-09-14T16:00:00Z |
| Expired |
string |
クラスターが期限切れになったかどうかを示します。 説明
このパラメーターは、サブスクリプションクラスターに対してのみ返されます。 |
false |
| CreateTime |
string |
クラスターが作成された時間。 |
2022-05-09T09:33:51Z |
| DBNodeClass |
string |
ノードの仕様。 |
polar.mysql.x4.medium |
| PayType |
string |
課金方法。有効な値：
|
Postpaid |
| DBType |
string |
データベースエンジンのタイプ。 |
MySQL |
| LockMode |
string |
クラスターのロック状態。有効な値：
|
Unlock |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| DeletionLock |
integer |
クラスターの削除ロックステータス。有効な値：
|
0 |
| DBVersion |
string |
データベースエンジンのバージョン。 |
8.0 |
| DBClusterId |
string |
クラスター ID。 |
pc-**************** |
| DBClusterStatus |
string |
クラスターのステータス。有効な値：
|
Running |
| IsDeleted |
integer |
クラスターがリリースされたかどうかを示します。有効な値：
|
1 |
| DBClusterNetworkType |
string |
クラスターのネットワークタイプ。 |
VPC |
| DBClusterDescription |
string |
クラスター名。 |
test |
| ZoneId |
string |
ゾーン ID。 |
cn-hangzhou-h |
| Engine |
string |
クラスターエンジン。 |
POLARDB |
例
成功レスポンス
JSONJSON
{
"RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
"PageNumber": 1,
"PageRecordCount": 1,
"TotalRecordCount": 1,
"Items": {
"DBCluster": [
{
"DeletedTime": "2022-05-12T03:25:37Z",
"VpcId": "vpc-******************",
"ExpireTime": "2022-09-14T16:00:00Z",
"Expired": "false",
"CreateTime": "2022-05-09T09:33:51Z",
"DBNodeClass": "polar.mysql.x4.medium",
"PayType": "Postpaid",
"DBType": "MySQL",
"LockMode": "Unlock",
"RegionId": "cn-hangzhou",
"DeletionLock": 0,
"DBVersion": "8.0",
"DBClusterId": "pc-****************",
"DBClusterStatus": "Running",
"IsDeleted": 1,
"DBClusterNetworkType": "VPC",
"DBClusterDescription": "test",
"ZoneId": "cn-hangzhou-h",
"Engine": "POLARDB"
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidRegionId.Malformed | The specified parameter RegionId is not valid. | |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。