調(diào)用DescribeDBClusterNetInfo接口查詢指定集群的網(wǎng)絡(luò)信息。
接口說明
當(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)、讀取(Read)或列出(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:DescribeClusterNetInfo | list | *DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企業(yè)版、基礎(chǔ)版或湖倉版的集群 ID。 說明
您可以調(diào)用 DescribeDBClusters 接口查看目標(biāo)地域下集群的詳情,包括集群 ID。
| amv-wz9dqvn0o7**** |
Engine | string | 否 | 數(shù)據(jù)庫引擎,取值:
| Clickhouse |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"ClusterNetworkType": "VPC",
"RequestId": "69A29B65-CD0C-52B1-BE42-8B454569747F",
"Items": {
"Address": [
{
"VSwitchId": "vsw-bp1syh8vvw8yec****",
"ConnectionString": "amv-wz9dqvn0o7****.ads.aliyuncs.com",
"NetType": "VPC",
"Port": "3306",
"VPCId": "vpc-8vbhucmd5b****",
"IPAddress": "192.168.xx.xx",
"ConnectionStringPrefix": "amv-wz9dqvn0o7****",
"Ports": {
"ports": [
{
"Port": "3306",
"Protocol": "mysql"
}
]
}
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ACS.InvalidParameter.%s | Parameter %s is invalid. | 輸入的參數(shù)無效 |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,請確認 DBClusterId 值是否正確。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-06-13 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |