调用AllocateInstancePublicConnection为AnalyticDB PostgreSQL版实例申请外网地址。

使用说明

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

QPS限制

本接口的单用户QPS限制默认为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AllocateInstancePublicConnection

系统规定参数。取值：AllocateInstancePublicConnection。

DBInstanceId String 是 gp-bp12ga6v69h86****

实例ID。

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

连接地址前缀。

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

Port String 是 5432

端口号，例如5432。
AddressType String 否 primary

网络类型。取值：

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

返回数据

名称 类型 示例值 描述
RequestId String ADD6EA90-EECB-4C12-9F26-0B6DB587****

请求ID。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=AllocateInstancePublicConnection
&DBInstanceId=gp-bp12ga6v69h86****
&ConnectionStringPrefix=gp-bp12ga6v69h86****
&Port=5432
&AddressType=primary
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<AllocateInstancePublicConnectionResponse>
    <RequestId>ADD6EA90-EECB-4C12-9F26-0B6DB587****</RequestId>
</AllocateInstancePublicConnectionResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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