Apply for a public endpoint for an instance by calling AllocateInstancePublicConnection - ApsaraDB for SelectDB - Alibaba Cloud - ApsaraDB for SelectDB

Applies for a public endpoint for an ApsaraDB for SelectDB instance.

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

selectdb:AllocateInstancePublicConnection

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	selectdb-cn-7213cjv****
NetType	string	Yes	The network type of the endpoint to be applied for. Set the value to Public.	Public
ConnectionStringPrefix	string	Yes	The prefix of the endpoint. Set the parameter to the prefix of the value of ConnectionString.	selectdb-cn-h033cn****-pub-i3
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	5ED62C81-9948-5612-81E1-EA3853752306
InstanceName	string	The name of the instance.	test-instance
TaskId	integer	The task ID.	498115273

Examples

Success response

JSON format

{
  "RequestId": "5ED62C81-9948-5612-81E1-EA3853752306",
  "InstanceName": "test-instance",
  "TaskId": 498115273
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstanceNetType.Malformed	The specified parameter "DBInstanceNetType" is not valid.	Illegal network type.
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	english description1
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	english description1
400	InvalidDBName	The specified database name is not allowed.	english description1
400	CreateOrderFailed	Failed to create order.	Failed to create order.
400	InvalidConnectionString.Duplicate	The specified connection string already exists.	The specified connection string already exists
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	The instance is in a state that does not support the current operation.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	The requested operation cannot be performed while the cluster is not running.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	english description1
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	english description1
403	MoneyLessThan100	The Account Monet less Than 100.	english description1
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	english description1
403	InsufficientResourceCapacity	The resource is out of usage.	Not enough resources, please try again later.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	Instance does not exist.
404	InvalidClusterInstance.NotFound	Specified cluster instance does not exist.	SelectDB instance does not exist.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	english description1
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	english description1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	english description1
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	english description1
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	english description1
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	english description1

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.