Use AllocateDirectConnection to apply for a private endpoint - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

With private endpoints, clients can bypass proxy nodes and connect to cluster instances in the same way as native Redis clusters, which reduces communication overhead and response latency.

The instance must meet the following requirements:

The instance is a cluster instance.
The instance is deployed in classic mode.
The instance is deployed in a virtual private cloud (VPC). If the instance is deployed in the classic network, you can call the SwitchNetwork operation to change the network type to VPC.
SSL encryption is disabled for the instance. If SSL encryption is enabled, you can call the ModifyInstanceSSL operation to disable SSL encryption.

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:AllocateDirectConnection

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****
ConnectionString	string	No	The prefix of the private endpoint. It must start with a lowercase letter, can contain lowercase letters and digits, and must be 8 to 40 characters in length.	redisdirect123
Port	string	No	The port number of the instance. Valid values: 1024 to 65535. Default value: 6379.	6379

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	5D622714-AEDD-4609-9167-F5DDD3D1****

Examples

Success response

JSON format

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NetTypeExists	Specified net type already existed
400	InvalidConnType	Specified DB instance conn type is not valid.
400	TaskHasExist	The task already exists.
400	ConnectionStringAlreadyExists	Specified connection string already exists in the Aliyun RDS.
400	InvalidConnectionString.Format	Specified connection string is not valid.	The connection string is invalid. Use a different one.
400	DirectConnectionAlreadyExists	Specified instance direct connection already exists.
400	InvalidVPCParamGroup	Specified vpc param group is not valid.
400	InvalidConnectionString	ConnectionString is invalid, valid regex: ^\w+$	The prefix of the endpoint is invalid. The prefix must start with a lowercase letter and can contain lowercase letters and digits. The prefix can be 8 to 40 characters in length.
403	UnsupportedEngineVersion	Current engine version does not support operations.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	InstanceStatus.NotSupport	Instance status does not support this operation.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.