瞭解 PolarDB 叢集網路端點架構 - 雲原生資料庫 PolarDB

查詢資料庫連接地址資訊

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDBClusterNetInfo

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 id。	pc-****************
ConnectionStringType	string	否	串連地址類型： Normal：主地址 ReadWriteSplitting：叢集地址 MPP: MPP 地址	Normal

返回參數

名稱	類型	描述	樣本值
	object	叢集地址串連資訊
DBClusterNetInfos	object
DBClusterNetInfo	array<object>	叢集地址串連資訊
	object	叢集地址串連資訊
VSwitchId	string	虛擬交換器 ID。	vsw-bp1li3eavsz8oaexq15dw
ConnectionStringType	string	串連地址類型： Normal：主地址 ReadWriteSplitting：叢集地址 MPP: MPP 地址	MPP
ConnectionString	string	資料庫連接地址。	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	IP 位址的網路類型，傳回值： Public：公網。 Inner：傳統網路。 Private：VPC 網路。	Public
Port	string	連接埠號碼。	1521
VPCId	string	專用網路 ID。	vpc-***************
IPAddress	string	IP 位址。	121...173
ClusterNetworkType	string	叢集網路類型，當前僅支援專用網路，取值固定為 VPC。	VPC
RequestId	string	請求 id。	72D99256-ACF1-5F86-831F-8CB53E9C23ED
DBNodeNetInfos	object
DBNodeNetInfo	array<object>	節點地址串連資訊
	array<object>	節點地址串連資訊
NetInfos	object
NetInfo	array<object>	節點地址串連資訊
	object	節點地址串連資訊
VSwitchId	string	虛擬交換器 ID。	vsw-*************
ConnectionString	string	資料庫連接地址。	pc-****************.pg.polardb.pre.rds.aliyuncs.com
IPType	string	IP 位址的網路類型，傳回值： Public：公網。 Inner：傳統網路。 Private：VPC 網路。	Public
Port	string	連接埠號碼。	5432
VPCId	string	專用網路 ID。	vpc-****************
IPAddress	string	IP 位址。	47...203
DBNodeRole	string	節點角色，取值範圍如下： Writer：主節點。 Reader：唯讀節點。 ColumnReader：列存唯讀節點。 AI：AI 節點。	Writer
DBInstanceId	string	執行個體 ID。	pc-*************

樣本

正常返回樣本

JSON格式

{
  "DBClusterNetInfos": {
    "DBClusterNetInfo": [
      {
        "VSwitchId": "vsw-bp1li3eavsz8oaexq15dw",
        "ConnectionStringType": "MPP",
        "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com",
        "IPType": "Public",
        "Port": "1521",
        "VPCId": "vpc-***************",
        "IPAddress": "121.*.*.173"
      }
    ]
  },
  "ClusterNetworkType": "VPC",
  "RequestId": "72D99256-ACF1-5F86-831F-8CB53E9C23ED",
  "DBNodeNetInfos": {
    "DBNodeNetInfo": [
      {
        "NetInfos": {
          "NetInfo": [
            {
              "VSwitchId": "vsw-*************",
              "ConnectionString": "pc-****************.pg.polardb.pre.rds.aliyuncs.com\n",
              "IPType": "Public",
              "Port": "5432",
              "VPCId": "vpc-****************",
              "IPAddress": "47.*.*.203"
            }
          ]
        },
        "DBNodeRole": "Writer",
        "DBInstanceId": "pc-*************"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	當前的記錄中不存在提供的DBClusterId。

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

變更歷史

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