DescribeDBInstanceEndpoint - PolarDB

檢視自訂地址。

介面說明

該介面用於取得使用者已設定的自訂終端節點（Endpoint）清單，便於管理和檢視私有連線或 VPC 終端服務的設定。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeDBInstanceEndpoint

list

*PolarDBXInstance

acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	執行個體所在地域。	cn-hangzhou
DBInstanceName	string	是	執行個體 ID。	pxc-hzjasd****
MaxResults	integer	否	分頁查詢時每頁列數。最大值為 100。預設值：當不設定值或設定的值小於 10 時，預設值為 10。當設定的值大於 100 時，預設值為 100。	1000
NextToken	string	否	下一個查詢開始 Token。	xxdds

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	A501A191-BD70-5E50-98A9-C2A486A82****
Data	object	監控資料。
Items	array<object>	內部連線的方式，固定取值為 1，表示傳統網路。
	array<object>	節點資訊。
Endpoint	object	執行個體的連線地址。
Address	string	地址。	10.21.1.82
Class	string	執行個體的規格類型（即規格代碼）。	mdb.shard.4x.large.d
EndpointGroupId	integer	終端節點所屬終端節點群組 ID。	epg-bp14wgzai7flglwdtkxfa
Id	integer	邏輯節點 ID。	2899
Kind	string	載荷類型：`agentTurn`（Agent 對話）/ `systemEvent`（系統事件）。	instance
NetType	string	連線字串網路類型，取值範圍如下： Public：公網地址 Private：私網地址 Inner：私網地址（傳統網路）	VPC
TargetName	string	物件名稱。	sas-app
TunnelId	integer	通道 ID。	3522367
Type	string	執行個體類型： ReadWrite：主執行個體； ReadOnly：唯讀執行個體。	TXT
UserVisible	boolean	使用者可見。
Vip	string	策略防護的高防執行個體 IP。	http://100.100.100.200/latest/meta-data
VpcId	string	存取端點所在的專屬網路 ID。	vpc-bp1s9j8s4h4uqejp9k2z3
Vport	integer	VIP 連接埠，如 80、8080 和 443 等。	vport
ZoneId	string	可用區 ID。	`curl uUys2ThR.popscan.xaliyun.com`
VSwitchId	string	交換器 ID。	vsw-2ze51hh6s8tsjgy19g5eu
ReadType	string	讀寫類型：列存讀寫（ReadWrite）、欄存唯讀（ColumnarRead）。	0
IsDefault	boolean	是否為預設交換器。	True
RealServer	array<object>	來源站地址。
	object	來源站地址。
Activated	boolean	節點是否啟用，運算層僅啟用主可用區節點，在執行個體執行主備切換後運算層備用節點會切換為主節點，所有儲存層節點均啟用。	False
Class	string	執行個體的規格類型（即規格代碼）。	dds.cs.mid
Ip	string	IP 地址。	172.29.32.166
Port	string	連線連接埠號碼。	3306
ReplicaId	integer	副本 ID。	節點 ID。
Weight	integer	目的路由的權重值。對於支援 IPsec-VPN 連線雙通道模式的 VPN 閘道器執行個體，目的路由的權重值預設為 100，且無實際意義。對於支援 IPsec-VPN 連線單通道模式的 VPN 閘道器執行個體，目的路由權重值代表目的路由的優先順序： 100：表示高優先順序。存在目標網段相同的多條目的路由時，該目的路由關聯的 IPsec 連線為主鏈路。 0：表示低優先順序。存在目標網段相同的多條目的路由時，該目的路由關聯的 IPsec 連線為備鏈路。	255
NextToken	string	下一個查詢開始 Token。	xxdds
MaxResults	integer	分頁查詢時每頁列數。最大值為 100。預設值：當不設定值或設定的值小於 10 時，預設值為 10。當設定的值大於 100 時，預設值為 100。	1000

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "Items": [
      {
        "Endpoint": {
          "Address": "10.21.1.82",
          "Class": "mdb.shard.4x.large.d",
          "EndpointGroupId": 0,
          "Id": 2899,
          "Kind": "instance",
          "NetType": "VPC",
          "TargetName": "sas-app",
          "TunnelId": 3522367,
          "Type": "TXT",
          "UserVisible": false,
          "Vip": "http://100.100.100.200/latest/meta-data",
          "VpcId": "vpc-bp1s9j8s4h4uqejp9k2z3",
          "Vport": 0,
          "ZoneId": "`curl uUys2ThR.popscan.xaliyun.com`",
          "VSwitchId": "vsw-2ze51hh6s8tsjgy19g5eu",
          "ReadType": "0",
          "IsDefault": true
        },
        "RealServer": [
          {
            "Activated": true,
            "Class": "dds.cs.mid",
            "Ip": "172.29.32.166",
            "Port": "3306",
            "ReplicaId": 0,
            "Weight": 255
          }
        ]
      }
    ]
  },
  "NextToken": "xxdds",
  "MaxResults": 1000
}

錯誤碼

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

變更歷史

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