AllocateInstancePublicConnection - AnalyticDB - Alibaba Cloud Documentation Center

Allocates a public endpoint for an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to apply for a public endpoint for an AnalyticDB for PostgreSQL instance. Both the primary and instance endpoints of an AnalyticDB for PostgreSQL instance can be public endpoints. For more information, see Endpoints of an instance and its primary coordinator node.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:AllocateInstancePublicConnection	update	DBInstance acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.	gp-bp12ga6v69h86****
ConnectionStringPrefix	string	Yes	The prefix of the endpoint. Specify a prefix for the endpoint. Example: `gp-bp12ga6v69h86**`. In this example, the endpoint is `gp-bp12ga6v69h86**.gpdb.rds.aliyuncs.com`.	gp-bp12ga6v69h86****
Port	string	Yes	The port number. Example: 5432.	5432
AddressType	string	No	The network type of the endpoint. Valid values: primary: primary endpoint cluster: instance endpoint. This value is supported only for an instance that contains multiple coordinator nodes. Note The default value is primary.	primary

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	ADD6EA90-EECB-4C12-9F26-0B6DB587****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history