カスタムクラスターのリストを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:DescribeAIDBClusters |
get |
*AICluster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBClusterIds |
string |
任意 |
クラスターの ID。複数のクラスター ID を指定する場合は、コンマ (,) で区切ります。 |
pc-*************** |
| PageSize |
integer |
任意 |
各ページで返すエントリ数。有効な値: 30、50、100。 デフォルト値: 30。 |
30 |
| PageNumber |
integer |
任意 |
ページ番号。 |
1 |
| DBClusterDescription |
string |
任意 |
クラスターの説明。あいまい一致をサポートしています。 |
pc-**************** |
| DBClusterStatus |
string |
任意 |
クラスターのステータス。有効な値:
|
Running |
| PayType |
string |
任意 |
課金方法。有効な値:
|
Prepaid |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-hangzhou |
| AiNodeType |
string |
任意 |
ノードタイプ。複数のタイプを指定する場合は、コンマ (,) で区切ります。有効な値:
|
vnode,container |
| Tag |
array<object> |
任意 |
タグリスト。 |
|
|
object |
任意 |
|||
| Key |
string |
任意 |
タグキー。タグでクラスターをフィルターできます。最大 20 個のタグキーと値のペアを指定できます。各タグペアの番号 n は一意であり、1 から始まる連続した整数である必要があります。Tag.n.Key の値は Tag.n.Value です。 |
testKey |
| Value |
string |
任意 |
タグキーに対応するタグ値。 |
testValueData |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ。 |
||
| RequestId |
string |
リクエストの ID。 |
9D6CE7C6-1C52-5BF6-B3D7-10977D44542C |
| TotalRecordCount |
integer |
エントリの総数。 |
5 |
| PageRecordCount |
integer |
現在のページで返されるエントリ数。 |
7 |
| PageNumber |
integer |
ページ番号。デフォルト値: 1。 |
1 |
| Items |
object |
||
| DBCluster |
array<object> |
AI クラスターのリスト。 |
|
|
array<object> |
AI クラスターの属性。 |
||
| DBClusterId |
string |
クラスターの ID。 |
pc-************** |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| ZoneId |
string |
ゾーンの ID。 |
cn-hangzhou-j |
| PayType |
string |
課金方法。有効な値:
|
Postpaid |
| DBClusterStatus |
string |
クラスターのステータス。 |
Creating |
| DBClusterDescription |
string |
クラスターの説明。 |
ocpx |
| VpcId |
string |
エンドポイントが存在する仮想非公開クラウド (VPC) の ID。 |
vpc-*************** |
| DBNodeClass |
string |
ノードスペック。 |
polar.pg.g8.8xlarge.gu30 |
| StorageType |
string |
ストレージタイプ。有効な値:
|
essdpl0 |
| StorageSpace |
integer |
変更後のストレージ容量。単位: GB。 |
10 |
| ExpireTime |
string |
有効期限の時間。 説明
このパラメーターは、サブスクリプションクラスターに対してのみ返されます。従量課金クラスターの場合、空の値が返されます。AI クラスターの有効期限の時間は、ISO 8601 協定世界時 (UTC) フォーマット (YYYY-MM-DDThh:mm:ssZ) で表示されます。 |
2028-09-01T16:00:00Z |
| Expired |
boolean |
クラスターが期限切れかどうかを示します。有効な値:
|
False |
| LockMode |
string |
クラスターのロックステータス。有効な値:
|
Unlock |
| CreateTime |
string |
クラスターが作成された時間。AI クラスターの作成時間は、ISO 8601 協定世界時 (UTC) フォーマット (YYYY-MM-DDThh:mm:ssZ) で表示されます。 |
2021-09-13T15:45:27Z |
| KubeClusterId |
string |
ACK クラスターの ID。 |
xxxxxxxxxxxx |
| RunType |
string |
実行タイプ。有効な値:
|
container |
| DBType |
string |
データベースエンジンのタイプ。polardb_ai のみサポートされています。 |
polardb_ai |
| AiNodeType |
string |
ノードタイプ。有効な値:
|
vnode |
| Tags |
object |
||
| Tag |
array<object> |
タグリスト。 |
|
|
object |
タグキー。タグでクラスターをフィルターできます。最大 20 個のタグキーと値のペアを指定できます。各タグペアの番号 n は一意であり、1 から始まる連続した整数である必要があります。Tag.n.Key の値は Tag.n.Value です。 |
||
| Key |
string |
タグキー。 |
testKey |
| Value |
string |
タグ値。 |
testValueData |
| VswitchId |
string |
vSwitch の ID。 |
vsw-************** |
| RelativeDBClusterId |
string |
統合クラスターインスタンスの ID。 |
pc-************** |
| ModelType |
string |
モデルのタイプ。 |
custom |
| ModelSpace |
string |
モデルスペース情報。 |
例
成功レスポンス
JSONJSON
{
"RequestId": "9D6CE7C6-1C52-5BF6-B3D7-10977D44542C",
"TotalRecordCount": 5,
"PageRecordCount": 7,
"PageNumber": 1,
"Items": {
"DBCluster": [
{
"DBClusterId": "pc-**************",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-j",
"PayType": "Postpaid",
"DBClusterStatus": "Creating",
"DBClusterDescription": "ocpx",
"VpcId": "vpc-***************",
"DBNodeClass": "\npolar.pg.g8.8xlarge.gu30",
"StorageType": "essdpl0",
"StorageSpace": 10,
"ExpireTime": "2028-09-01T16:00:00Z",
"Expired": true,
"LockMode": "Unlock",
"CreateTime": "2021-09-13T15:45:27Z",
"KubeClusterId": "xxxxxxxxxxxx",
"RunType": "container",
"DBType": "polardb_ai",
"AiNodeType": "vnode",
"Tags": {
"Tag": [
{
"Key": "testKey",
"Value": "testValueData"
}
]
},
"VswitchId": "vsw-**************",
"RelativeDBClusterId": "pc-**************",
"ModelType": "custom",
"ModelSpace": ""
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。