AnalyticDB:AllocateInstancePublicConnection - AnalyticDB - Alibaba Cloud - AnalyticDB

Operation description

Applies for a public endpoint for an AnalyticDB for PostgreSQL instance. Both the primary endpoint and the instance endpoint support public access. 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. Exceeding this limit triggers throttling, which may affect your business.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gpdb:AllocateInstancePublicConnection

update

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call DescribeDBInstances to query the IDs of all AnalyticDB for PostgreSQL instances in a region.	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 elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.