CreateGlobalDistributeCache -

Converts an existing ApsaraDB for Redis instance to the first child instance of a distributed ApsaraDB for Redis instance.

Operation description

You cannot directly create a distributed instance. If you require a distributed instance, you must call this operation to convert an existing instance to the first child instance of the distributed instance. After the instance is converted, the distributed instance is created. Before you call this operation, make sure that the following requirements are met:

A DRAM-based instance of Enhanced Edition is used.
If the existing instance is a cluster instance, the direct connection mode must be disabled for the instance. For more information, see Release a private endpoint.

Note You can also call the CreateInstance operation to create an instance that is specified as the first child instance of a distributed instance. After the child instance is created, the distributed instance to which the child instance belongs is created.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:CreateGlobalDistributeCache	update	DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
SeedSubInstanceId	string	Yes	The ID of the existing instance.	r-bp1zxszhcgatnx****
ResourceGroupId	string	No	The ID of the resource group. Note You do not need to specify system parameters.	rg-acfmyiu4ekp****
EffectiveTime	string	No	The time when you want to restart the instance. Default value: Immediately. Valid values: Immediately: immediately restarts the instance. MaintainTime: restarts the instance during the maintenance window.	Immediately

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	E681E498-5A0D-44F2-B1A7-912DC3******

Examples

Sample success responses

JSONformat

{
  "RequestId": "E681E498-5A0D-44F2-B1A7-912DC3******"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-22	The request parameters of the API has changed	View Change Details
2023-07-25	The request parameters of the API has changed	View Change Details
2023-03-02	The internal configuration of the API is changed, but the call is not affected	View Change Details