創(chuàng)建PolarDB集群主地址、默認集群地址和自定義集群地址的公網(wǎng)連接地址。
接口說明
說明
支持為 PolarDB 集群的主地址、默認集群地址和自定義集群地址創(chuàng)建公網(wǎng)連接地址。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
polardb:CreateDBEndpointAddress | Write |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 | pc-************** |
DBEndpointId | string | 是 | 連接地址 ID。 說明
可通過接口 DescribeDBClusterEndpoints 查詢連接地址詳情。
| pe-************** |
ConnectionStringPrefix | string | 否 | 新的連接地址前綴。連接地址前綴需滿足如下條件:
| test-1 |
NetType | string | 是 | 新增連接地址的網(wǎng)絡類型,固定為 Public(公網(wǎng))。 | Public |
VPCId | string | 否 | 專有網(wǎng)絡 ID | vpc-********** |
SecurityGroupId | string | 否 | ECS 安全組 ID | sg-bp************** |
ZoneInfo | object [] | 否 | 可用區(qū)信息。 | |
ZoneId | string | 否 | 可用區(qū) ID。 | cn-hangzhou-b |
VSwitchId | string | 否 | 虛擬交換機 ID。 | vsw-********** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | EndpointStatus.NotSupport | Current endpoint status does not support this operation. | 當前節(jié)點狀態(tài)不支持此操作 |
400 | NetTypeExists | Specified net type already existed. | 指定的網(wǎng)絡類型已存在 |
400 | MissParameter.NetType | When NetType is set to NlbVpc, the VPCId, SecurityGroupId and ZoneInfo is needed. | NetType 為 NlbVpc 時,VPCId、SecurityGroupId 和 ZoneInfo 不能為空。 |
400 | InvalidDBEndpointId.Malformed | The specified parameter DBEndpointId is not valid. | 指定的參數(shù)DBEndpointId無效 |
400 | InvalidNetType.Malformed | The specified parameter NetType is not valid. | 指定的參數(shù)NetType無效。 |
400 | InvalidConnectionStringPrefix.Malformed | The specified parameter ConnectionStringPrefix is not valid. | 指定的參數(shù)ConnectionStringPrefix無效。 |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的 DBClusterId。 |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的參數(shù)DBClusterId無效 |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 錯誤碼發(fā)生變更 | 看變更集 | ||||||||||||||
| ||||||||||||||||
2023-06-12 | OpenAPI 錯誤碼發(fā)生變更 | 看變更集 | ||||||||||||||
| ||||||||||||||||
2023-05-11 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 看變更集 | ||||||||||||||
|