使用DescribeDBClusterNetInfoItems查詢叢集網路資訊-雲資料庫 ClickHouse-阿里雲

查詢指定雲資料庫ClickHouse叢集的網路資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:DescribeDBClusterNetInfoItems

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	cc-bp1qx68m06981****

返回參數

名稱	類型	描述	樣本值
	object
NetInfoItems	object
NetInfoItem	array<object>	網路資訊列表。
	object	網路資訊列表。
VpcId	string	VPC ID。說明串連地址的網路類型為 Public 時，傳回值為空白。	vpc-bp175iuvg8nxqraf2****
VSwitchId	string	交換器 ID。說明串連地址的網路類型為 Public 時，傳回值為空白。	vsw-bp1gzt31twhlo0sa5****
ConnectionString	string	資料庫連接地址。	cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com
JdbcPort	string	JDBC 連接埠號碼。	3306
NetType	string	串連地址的網路類型，取值： Public：公網。 VPC：VPC。	VPC
HttpPort	string	HTTP 連接埠號碼。	8123
IPAddress	string	IP 位址。	10.255.234.251
HttpsPort	string	HTTPS 連接埠號碼。	8443
MySQLPort	string	MySQL 連接埠號碼。	9004
ClusterNetworkType	string	網路類型，目前只支援 VPC。	VPC
RequestId	string	請求 ID。	9A23C87D-87DF-4DA0-A50E-CB13F4F7923D
EnableSLB	boolean	VPC 中是否開啟了 SLB。取值說明： true：開啟。 false：不開啟。	true

樣本

正常返回樣本

JSON格式

{
  "NetInfoItems": {
    "NetInfoItem": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "ConnectionString": "cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com",
        "JdbcPort": "3306",
        "NetType": "VPC",
        "HttpPort": "8123",
        "IPAddress": "10.255.234.251",
        "HttpsPort": "8443",
        "MySQLPort": "9004"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D",
  "EnableSLB": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。