ターゲットリージョン内の Data Lakehouse Edition クラスターを一覧表示します。
操作説明
現在のサービスのエンドポイントについては、「エンドポイント」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
adb:DescribeDBClusters |
list |
*DBClusterLakeVersion
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 説明
リージョン ID を表示するには、DescribeRegions 操作を呼び出します。 |
cn-hangzhou |
| DBClusterIds |
string |
任意 |
Data Lakehouse Edition クラスター ID。 このパラメーターを指定しない場合、デフォルトでリージョン内のすべてのクラスターに関する情報が返されます。 |
amv-bp1r053byu48p**** |
| DBClusterDescription |
string |
任意 |
クラスターの説明。
|
test |
| DBClusterStatus |
string |
任意 |
クラスターのステータス。有効な値：
|
Running |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。有効な値：
|
30 |
| PageNumber |
integer |
任意 |
ページ番号。有効な値：0 より大きく、integer データ型の最大値以下の正の整数。デフォルト値：1。 |
1 |
| ResourceGroupId |
string |
任意 |
このパラメーターを指定しない場合、デフォルトでクラスター内のすべてのリソースグループに関する情報が返されます。 |
rg-4690g37929**** |
| Tag |
array<object> |
任意 |
クラスターのタグ。 |
|
|
object |
任意 |
クラスターのタグ情報。 |
||
| Key |
string |
任意 |
タグキー。 |
tag1 |
| Value |
string |
任意 |
タグ値。 |
test1 |
| ProductVersion |
string |
任意 |
プロダクトバージョン。有効な値：
説明
これはオプションのパラメーターです。指定しない場合、デフォルトですべてのクラスターに関する情報が返されます。 |
BasicVersion |
| DBClusterVersion |
string |
任意 |
クラスターバージョン。有効な値：
|
5.0 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| TotalCount |
integer |
エントリの総数。 |
1 |
| PageSize |
integer |
1 ページあたりのエントリ数。 |
30 |
| RequestId |
string |
リクエスト ID。 |
A5EDBA27-AF3E-5966-9503-FD1557E19167 |
| PageNumber |
integer |
ページ番号。 |
1 |
| Items |
object |
||
| DBCluster |
array<object> |
詳細なリスト情報。 |
|
|
array<object> |
クラスターリスト。 |
||
| Expired |
string |
サブスクリプションクラスターが期限切れになったかどうかを示します。有効な値：
説明
|
false |
| CreateTime |
string |
クラスターが作成された時間 (協定世界時 (UTC))。フォーマット：yyyy-MM-ddTHH:mm:ssZ。 |
2022-04-01T09:50:18Z |
| PayType |
string |
課金方法。有効な値：
|
Prepaid |
| Mode |
string |
クラスターモード。デフォルト値：flexible (弾性モードクラスターを示します)。 |
flexible |
| Port |
string |
クラスターのポート番号。 |
3306 |
| LockMode |
string |
クラスターのロックステータス。有効な値：
|
Unlock |
| StorageResource |
string |
予約済みのストレージリソースの仕様。1 ACU は約 1 vCPU と 4 GB のメモリに相当します。ストレージリソースは、データの読み書き操作に使用されます。このリソースを増やすと、クラスターの読み書き性能が向上します。 |
24ACU |
| DBClusterId |
string |
Data Lakehouse Edition クラスター ID。 |
amv-bp163885f8q21**** |
| ConnectionString |
string |
クラスターのパブリックエンドポイント。 |
amv-bp163885f8q21****.ads.aliyuncs.com |
| DBClusterType |
string |
クラスタータイプ。デフォルト値：Common (標準クラスターを示します)。 |
Common |
| CommodityCode |
string |
商品の課金方法。有効な値：
|
ads_pre |
| ExpireTime |
string |
クラスターの有効期限が切れる時間 (協定世界時 (UTC))。フォーマット：yyyy-MM-ddTHH:mm:ssZ。 説明
|
2022-07-01T09:50:18Z |
| LockReason |
string |
クラスターがロックされている理由。 説明
このパラメーターは、クラスターがロックされている場合にのみ返されます。値は常に instance_expire です。 |
instance_expired |
| VPCId |
string |
Virtual Private Cloud (VPC) ID。 |
vpc-bp13h7uzhulpuxvnp**** |
| RegionId |
string |
クラスターが存在するリージョン ID。 |
cn-hangzhou |
| ComputeResource |
string |
予約済みの計算リソースの仕様。1 ACU は約 1 vCPU と 4 GB のメモリに相当します。計算リソースはデータ処理に使用されます。計算リソースを増やすと、クエリが高速化されます。クラスターのパフォーマンスニーズに基づいて、これらのリソースをスケールアップまたはスケールダウンできます。 |
16ACU |
| VSwitchId |
string |
vSwitch ID。 |
vsw-bp1syh8vvw8yech7n**** |
| DBVersion |
string |
データベースバージョン。バージョン 5.0 のみがサポートされています。 |
5.0 |
| DBClusterStatus |
string |
クラスターのステータス。有効な値：
|
Running |
| ResourceGroupId |
string |
リソースグループ ID。 |
rg-acfmyiu4ekp**** |
| DBClusterNetworkType |
string |
クラスターのネットワークタイプ。VPC のみがサポートされています。 |
VPC |
| DBClusterDescription |
string |
クラスターの説明。 |
adb_test |
| ZoneId |
string |
クラスターが存在するゾーン ID。 |
cn-hangzhou-h |
| Engine |
string |
クラスターエンジン。固定値：AnalyticDB。 |
AnalyticDB |
| ReservedACU |
string |
割り当て可能な残りの予約済み計算リソース。1 ACU は約 1 vCPU と 4 GB のメモリに相当します。 |
32ACU |
| Tags |
object |
||
| Tag |
array<object> |
タグリスト。 |
|
|
object |
タグリスト。 |
||
| Key |
string |
タグキー。 説明
ターゲットクラスターのタグを作成するには、TagResources 操作を呼び出します。 |
tag1 |
| Value |
string |
タグ値。 |
test1 |
| Category |
string |
プロダクトシリーズ。このパラメーターは、Data Warehouse Edition インスタンスに対してのみ意味があります。有効な値：
説明
プロダクトシリーズの詳細については、「プロダクトシリーズ」をご参照ください。 |
MIXED_STORAGE |
| InnerPort |
string |
クラスターの内部ネットワークポート。 |
3306 |
| VPCCloudInstanceId |
string |
内部エンドポイント。 |
am-bp163885f8q21****-controller |
| InnerIp |
string |
クラスターの内部 IP アドレス。 |
10.1.xx.xx |
| DtsJobId |
string |
DTS 同期タスク ID。このパラメーターは、MySQL 分析インスタンスに対してのみ返されます。 |
dtsb1578j90XXXX |
| ElasticIOResource |
integer |
Elastic IO Unit (EIU)。詳細については、「EIU の詳細」をご参照ください。 説明
このパラメーターは、弾性モードクラスターに対してのみ返されます。 |
2 |
| RdsInstanceId |
string |
同期元の RDS インスタンス ID。このパラメーターは、MySQL 分析インスタンスに対してのみ返されます。 |
rm-bp11q28kvl688**** |
| ExecutorCount |
string |
弾性モードでクラスターが使用する計算ノードの数。 |
1 |
| DBNodeClass |
string |
ノード仕様。このパラメーターは、Data Warehouse Edition インスタンスに対してのみ意味があります。 |
E8 |
| DiskType |
string |
ディスクタイプ。有効な値：
説明
ESSD ディスクの詳細については、「ESSD ディスクの仕様」をご参照ください。 |
cloud_essd |
| DBNodeStorage |
integer |
クラスターのストレージ容量 (GB)。 |
300 |
| DBNodeCount |
integer |
ノードグループの数。 |
2 |
| TaskInfo |
object |
タスクの進捗情報。 |
|
| Name |
string |
タスク名。 |
analyticDBFlexibleScaleOut |
| Status |
string |
タスクのステータス。有効な値：
|
RUNNING |
| Progress |
string |
タスクの進捗状況 (%)。 |
10% |
| StepList |
object |
||
| StepList |
array<object> |
タスクのステップ。 |
|
|
object |
タスクのステップ。 |
||
| StepName |
string |
ステップ名。 |
ApplyResource |
| StepDesc |
string |
ステップの説明。 |
Apply resource |
| StepStatus |
string |
ステップのステータス。有効な値：
|
SUCCEED |
| StepProgress |
string |
ステップの進捗状況 (%)。 |
50% |
| StartTime |
string |
ステップの開始時間。フォーマット：YYYY-MM-DDTHH:mm:ssZ。 |
2024-03-10T09:28:34Z |
| EndTime |
string |
ステップの終了時間。フォーマット：YYYY-MM-DDTHH:mm:ssZ。 |
2024-03-10T10:28:34Z |
| ProductForm |
string |
プロダクトフォーム。有効な値：
|
IntegrationForm |
| ProductVersion |
string |
プロダクトバージョン。有効な値：
|
EnterpriseVersion |
| ReservedNodeSize |
string |
各予約済みリソースノードの仕様。 |
8ACU |
| ReservedNodeCount |
integer |
予約済みリソースノードの数。 |
1 |
| AINodeSpec |
string |
||
| AINodeNumber |
integer |
例
成功レスポンス
JSONJSON
{
"TotalCount": 1,
"PageSize": 30,
"RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
"PageNumber": 1,
"Items": {
"DBCluster": [
{
"Expired": "false",
"CreateTime": "2022-04-01T09:50:18Z",
"PayType": "Prepaid",
"Mode": "flexible",
"Port": "3306",
"LockMode": "Unlock",
"StorageResource": "24ACU",
"DBClusterId": "amv-bp163885f8q21****",
"ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
"DBClusterType": "Common",
"CommodityCode": "ads_pre",
"ExpireTime": "2022-07-01T09:50:18Z",
"LockReason": "instance_expired",
"VPCId": "vpc-bp13h7uzhulpuxvnp****",
"RegionId": "cn-hangzhou",
"ComputeResource": "16ACU",
"VSwitchId": "vsw-bp1syh8vvw8yech7n****",
"DBVersion": "5.0",
"DBClusterStatus": "Running",
"ResourceGroupId": "rg-acfmyiu4ekp****",
"DBClusterNetworkType": "VPC",
"DBClusterDescription": "adb_test",
"ZoneId": "cn-hangzhou-h",
"Engine": "AnalyticDB",
"ReservedACU": "32ACU",
"Tags": {
"Tag": [
{
"Key": "tag1",
"Value": "test1"
}
]
},
"Category": "MIXED_STORAGE",
"InnerPort": "3306",
"VPCCloudInstanceId": "am-bp163885f8q21****-controller",
"InnerIp": "10.1.xx.xx",
"DtsJobId": "dtsb1578j90XXXX",
"ElasticIOResource": 2,
"RdsInstanceId": "rm-bp11q28kvl688****",
"ExecutorCount": "1",
"DBNodeClass": "E8",
"DiskType": "cloud_essd",
"DBNodeStorage": 300,
"DBNodeCount": 2,
"TaskInfo": {
"Name": "analyticDBFlexibleScaleOut",
"Status": "RUNNING",
"Progress": "10%",
"StepList": {
"StepList": [
{
"StepName": "ApplyResource",
"StepDesc": "Apply resource",
"StepStatus": "SUCCEED",
"StepProgress": "50%",
"StartTime": "2024-03-10T09:28:34Z",
"EndTime": "2024-03-10T10:28:34Z"
}
]
}
},
"ProductForm": "IntegrationForm",
"ProductVersion": "EnterpriseVersion",
"ReservedNodeSize": "8ACU",
"ReservedNodeCount": 1,
"AINodeSpec": "",
"AINodeNumber": 0
}
]
}
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. | An error occurred while processing your request. |
| 503 | ServiceUnavailable | An error occurred while processing your request. | An error occurred while processing your request. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。