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

Applies for a direct connection endpoint for an ApsaraDB Tair (Redis® OSS-Compatible) database cluster instance.

Operation description

Clients can use the direct connection endpoint to bypass the proxy and connect to the cluster instance in the same way as they connect to a native Redis cluster. This reduces link overhead and further improves the response speed of the ApsaraDB Tair (Redis® OSS-Compatible) database service.

The instance for which you invoke this operation must meet the following conditions:

The instance uses the cluster architecture.
The deployment pattern is classic.
The network type of the instance is VPC. If the instance is connected to the classic network, you can invoke the SwitchNetwork operation to switch the network type to VPC.
The Secure Sockets Layer (SSL) encryption feature is disabled for the instance. If the Secure Sockets Layer (SSL) encryption feature is enabled, you can invoke the ModifyInstanceSSL operation for shutdown.

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 instance ID. Only cluster instances deployed in classic mode are supported. For instances deployed in classic mode, the value of the ComputingType parameter is Machine. You can call the DescribeInstances operation to query the ComputingType parameter.	r-bp1zxszhcgatnx****
ConnectionString	string	No	The prefix of the direct connection endpoint. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start with a lowercase letter. Default value: the instance ID followed by `-direct`. For example, if the instance ID is r-8vbwsicr5d5gse**, the default value is `r-8vbwsicr5d5gse**-direct`.	redisdirect123
Port	string	No	The port number. Valid values: 1024 to 65535. Default value: 6379.	6379

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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.