AllocateInstancePublicConnection - Apply for a public endpoint for a Redis instance - Tair (Redis® OSS-Compatible)

Operation description

You can also apply for public endpoints in the ApsaraDB for Redis console. Use a public endpoint to connect to an ApsaraDB for Redis 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

kvstore:AllocateInstancePublicConnection

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
ConnectionStringPrefix	string	Yes	The prefix of the public endpoint. Must start with a lowercase letter and can contain lowercase letters and digits. Length: 8 to 40 characters. Note Endpoint format: `<prefix>.redis.rds.aliyuncs.com`.	r-bp1zxszhcgatnx****
Port	string	Yes	The port number of the instance. Valid values: 1024 to 65535.	6379

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	20C8341E-B5AD-4B24-BD82-D73241522ABF

Examples

Success response

JSON format

{
  "RequestId": "20C8341E-B5AD-4B24-BD82-D73241522ABF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingInstanceId	InstanceId is mandatory for this action.
400	MissingConnectionString	ConnectionStringPrefix is mandatory for this action.
400	MissingPort	Port is mandatory for this action.
400	NetTypeExists	Specified net type already existed.	The specified network type already exists
400	InvalidConnectionString.Format	Specified connection string is not valid.	The connection string is invalid. Use a different one.
400	NewSSLAlreadyEnabled	new SSL have already been enabled.	The instance has the new SSL certificate enabled.
403	SSLNotSupportNetType	SSL instance does not support create public network.	SSL-enabled instances do not allow you to create public networks.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.