分配實例外網鏈接地址。
接口說明
本接口用于申請 AnalyticDB PostgreSQL 版實例的外網地址。AnalyticDB PostgreSQL 版實例的主地址和集群地址均支持創建外網地址,更多介紹,請參見主地址和集群地址。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
gpdb:AllocateInstancePublicConnection | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 說明
您可以調用 DescribeDBInstances 接口查看目標地域下所有的 AnalyticDB PostgreSQL 實例的詳情,包括實例 ID。
| gp-bp12ga6v69h86**** |
ConnectionStringPrefix | string | 是 | 連接地址前綴。 您可以自定義連接地址前綴,例如連接地址前綴為 | gp-bp12ga6v69h86**** |
Port | string | 是 | 端口號,例如 5432。 | 5432 |
AddressType | string | 否 | 網絡類型。取值:
說明
默認為主地址。
| primary |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "ADD6EA90-EECB-4C12-9F26-0B6DB587****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史