AllocateInstancePublicConnection - 申请外网地址

分配实例外网链接地址。

接口说明

本接口用于申请 AnalyticDB PostgreSQL 版实例的外网地址。AnalyticDB PostgreSQL 版实例的主地址和集群地址均支持创建外网地址,更多介绍,请参见主地址和集群地址

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:AllocateInstancePublicConnectionupdate
  • DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp12ga6v69h86****
ConnectionStringPrefixstring

连接地址前缀。

您可以自定义连接地址前缀,例如连接地址前缀为gp-bp12ga6v69h86****时,连接地址为gp-bp12ga6v69h86****.gpdb.rds.aliyuncs.com

gp-bp12ga6v69h86****
Portstring

端口号,例如 5432。

5432
AddressTypestring

网络类型。取值:

  • primary:主地址。
  • cluster:集群地址,仅多协调节点实例支持创建集群地址。
说明 默认为主地址。
primary

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ADD6EA90-EECB-4C12-9F26-0B6DB587****

示例

正常返回示例

JSON格式

{
  "RequestId": "ADD6EA90-EECB-4C12-9F26-0B6DB587****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史