カスタムクラスターを表示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardb:DescribeAIDBClusters |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| DBClusterIds |
string |
任意 |
クラスター ID。 複数のクラスターを指定する場合は、ID をコンマ (,) で区切ります。 |
pc-*************** |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。 有効値：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 |
任意 |
タグキー。 このパラメーターを `Tag.n.Value` と共に使用して、タグでクラスターをフィルターします。 最大 20 個のタグペアを指定できます。 インデックス n は、1 から始まる一意の連続した整数である必要があります。 |
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 |
AI クラスターの詳細。 |
|
| 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 |
有効期限。 説明
このパラメーターは、サブスクリプションクラスターの場合にのみ返されます。 従量課金クラスターの場合、このパラメーターは空です。 |
2028-09-01T16:00:00Z |
| Expired |
boolean |
クラスターが期限切れになったかどうかを示します。 有効値：
|
False |
| LockMode |
string |
クラスターのロック状態。 有効値：
|
Unlock |
| CreateTime |
string |
クラスターが作成された時間。 |
2021-09-13T15:45:27Z |
| KubeClusterId |
string |
Container Service for Kubernetes (ACK) クラスターの ID。 |
xxxxxxxxxxxx |
| RunType |
string |
実行タイプ。 有効値：
|
container |
| DBType |
string |
データベースエンジンのタイプ。 polardb_ai のみがサポートされています。 |
polardb_ai |
| AiNodeType |
string |
ノードタイプ。 有効値は、vnode (Kubernetes が管理するノード)、container (ログインをサポートするコンテナ)、maas (モデルサービス) です。 vnode: Kubernetes によって管理されるノード；コンテナ: ログインが可能なコンテナ；maas: モデルサービス。 |
vnode |
| Tags |
object |
クラスターのタグ。 |
|
| Tag |
array<object> |
タグのリスト。 |
|
|
object |
クラスターにアタッチされたタグ。 |
||
| Key |
string |
タグキー。 |
testKey |
| Value |
string |
タグ値。 |
testValueData |
| VswitchId |
string |
VSwitch ID。 |
vsw-************** |
| RelativeDBClusterId |
string |
関連付けられたクラスターインスタンスの ID。 |
pc-************** |
| ModelType |
string |
モデルタイプ。 |
custom |
例
成功レスポンス
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"
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。