CreateCustomEndpoint - PolarDB

介面說明

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:CreateCustomEndpoint

create

*PolarDBXInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceName	string	是	執行個體 ID。	pxc-hzjasd****
Name	string	是	存取控制執行個體名稱。名稱長度為 2~128 個字元，以大小寫字母或中文開頭，可包含數字、底線（_）和連字號（-）。	ext-win-live-17
VpcId	string	是	存取端點所在的專有網路 ID。	vpc-bp1ndoug37dtwoedlmru0
VSwitchId	string	是	虛擬交換器 ID。	vsw-*********
NodeIds	string	是	當 RemindUnit（物件類型）為 NODE（任務節點）時，監控的任務節點 ID。多個 ID 之間使用英文逗號（,）分隔，一個規則最多監控 50 個節點。	r-bp1l5kfgw8****c3iv
NodeAutoEnter	boolean	是	節點在被新增或還原後，是否自動加入叢集並開始提供服務。	true
NodeRole	string	否	若希望查詢雲端原生版讀寫分離架構執行個體中唯讀節點的指標，您在傳入具體 NodeId 的同時，還需要在本參數傳入 READONLY。說明其餘情況無需傳入（或傳入 MASTER）。	READONLY
RegionId	string	否	執行個體所在地域。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	Id of the request	2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9
Data	object	返回資料。
CustomEndpointId	string	終端 ID。	pxe-c4gkgqg****7sgyg
DBInstanceName	string	執行個體 ID。	pxc-*********

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9",
  "Data": {
    "CustomEndpointId": "pxe-c4gkgqg****7sgyg",
    "DBInstanceName": "pxc-*********"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	CustomEndpoint.ExceedLimit	the count of custom endpoints can not exceed limiting value.

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

變更歷史

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