查看目標(biāo)地域下的湖倉版集群列表信息。
接口說明
當(dāng)前服務(wù)的接入地址請參見服務(wù)接入點。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| adb:DescribeDBClusters | list |
|
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 說明
您可以調(diào)用 DescribeRegions 接口查看地域 ID。
| cn-hangzhou |
| DBClusterIds | string | 否 | AnalyticDB MySQL 湖倉版（3.0）集群 ID。 此參數(shù)不填寫時，默認(rèn)返回該地域中所有集群的信息。 | amv-bp1r053byu48p**** |
| DBClusterDescription | string | 否 | 集群描述。
| test |
| DBClusterStatus | string | 否 | 集群狀態(tài)，取值說明：
| Running |
| PageSize | integer | 否 | 每頁記錄數(shù)，取值：
| 30 |
| PageNumber | integer | 否 | 頁碼，取值為大于 0 且不超過 Integer 數(shù)據(jù)類型的正整數(shù)。默認(rèn)值為 1。 | 1 |
| ResourceGroupId | string | 否 | 資源組 ID。 此參數(shù)不填寫時，默認(rèn)返回集群中所有資源組信息。 | rg-4690g37929**** |
| Tag | array<object> | 否 | 集群的標(biāo)簽信息。 | |
| object | 否 | |||
| Key | string | 否 | 集群的標(biāo)簽鍵。 | tag1 |
| Value | string | 否 | 集群的標(biāo)簽值。 | test1 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"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": "",
"InnerPort": "",
"VPCCloudInstanceId": "",
"InnerIp": "",
"DtsJobId": "",
"ElasticIOResource": 0,
"RdsInstanceId": "",
"ExecutorCount": "",
"DBNodeClass": "",
"DiskType": "",
"DBNodeStorage": 0,
"DBNodeCount": 0,
"TaskInfo": {
"Name": "",
"Status": "",
"Progress": "",
"StepList": {
"StepList": [
{
"StepName": "",
"StepDesc": "",
"StepStatus": "",
"StepProgress": "",
"StartTime": "",
"EndTime": ""
}
]
}
},
"ProductForm": "",
"ProductVersion": "",
"ReservedNodeSize": "",
"ReservedNodeCount": 0
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. | 系統(tǒng)內(nèi)部錯誤，請稍后重試 |
| 503 | ServiceUnavailable | An error occurred while processing your request. | 系統(tǒng)暫時不可用，請稍后重試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-05-28 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2024-05-09 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-07-27 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |