DescribeCustomEndpointList - PolarDB

查詢自訂網域列表。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeCustomEndpointList

list

*PolarDBXInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	執行個體所在地域。	cn-hangzhou
DBInstanceName	string	是	執行個體名稱。	pxc-xxx
CustomEndpointIds	string	否	自訂網域 ID。	pxe-b6e****no4pfap1s
CheckDeleteCN	boolean	否	查詢 CN 是否已刪除。	true

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	6352AC16-76BF-5135-B1EA-ED49293526E6
Data	object	資料結構。
CanDeleteCount	integer	是否為可刪除節點。	0
Endpoints	array<object>	Endpoint 詳細資訊。
	object	Endpoint 詳細資訊。
CustomEndpointId	string	用戶端網域名稱 id。	pxe-b6e****o4pfap1s
Name	string	名稱。	Name
DBInstanceName	string	執行個體 ID。	pxc-hz****zoxherr7
ConnectionString	string	執行個體連線位址	pxc-shra****zq0j01.polarx.rds.aliyuncs.com
Port	integer	執行個體連線連接埠	3306
VpcId	string	存取端點所在的專有網路 ID。	vpc-uf61h****dj1zg5fqp5x7
VSwitchId	string	虛擬交換機 ID。	vsw-8vbkw****5yh4nrd639ih
NodeAutoEnter	string	節點在被新增或復原後，是否自動加入叢集並開始提供服務	true
NodeRole	string	若希望查詢雲原生版讀寫分離架構執行個體中唯讀節點的指標，您在傳入具體 NodeId 的同時，還需要在本參數傳入 READONLY。說明其餘情況請無需傳入（或傳入 MASTER）。	same_azone_as_last
CnNames	array	["pxc-i-vb1sqa7llp","pxc-i-bemprx50ad"]
	string	string	string
Status	string	狀態	created

樣本

正常返回樣本

JSON格式

{
  "RequestId": "6352AC16-76BF-5135-B1EA-ED49293526E6",
  "Data": {
    "CanDeleteCount": 0,
    "Endpoints": [
      {
        "CustomEndpointId": "pxe-b6e****o4pfap1s",
        "Name": "Name",
        "DBInstanceName": "pxc-hz****zoxherr7",
        "ConnectionString": "pxc-shra****zq0j01.polarx.rds.aliyuncs.com",
        "Port": 3306,
        "VpcId": "vpc-uf61h****dj1zg5fqp5x7",
        "VSwitchId": "vsw-8vbkw****5yh4nrd639ih",
        "NodeAutoEnter": "true",
        "NodeRole": "same_azone_as_last",
        "CnNames": [
          "string"
        ],
        "Status": "created"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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