Convert an existing instance to a distributed instance using CreateGlobalDistributeCache - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

This operation converts an existing instance into the first sub-instance of a distributed instance. The conversion also creates the distributed instance. The source instance must meet the following requirements:

The source instance must be a classic Tair memory-enhanced instance.
If the source instance uses the cluster architecture, you must disable the direct connection mode. For more information, see ReleasePublicConnection.

Note

Alternatively, you can call the CreateInstance operation to create a new instance to use as the first sub-instance. This action also creates the distributed 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:CreateGlobalDistributeCache

update

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
SeedSubInstanceId	string	Yes	The ID of the source instance.	r-bp1zxszhcgatnx****
ResourceGroupId	string	No	The ID of the resource group. Note This is a system parameter. You do not need to specify it.	-
EffectiveTime	string	No	Specifies when to perform the operation. Valid values: Immediately: Performs the operation immediately. MaintainTime: Performs the operation during the maintenance window. This is the default value. Note You can call the ModifyInstanceMaintainTime operation to change the maintenance window of the instance.	Immediately

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E681E498-5A0D-44F2-B1A7-912DC3******
GlobalInstanceId	string	The ID of the distributed instance.	gr-8vbzg1y6m****t38p
InstanceId	string	The ID of the instance.	r-8vb6ffc5****4ec4

Examples

Success response

JSON format

{
  "RequestId": "E681E498-5A0D-44F2-B1A7-912DC3******",
  "GlobalInstanceId": "gr-8vbzg1y6m****t38p",
  "InstanceId": "r-8vb6ffc5****4ec4"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.