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

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 specified instance is converted to the first child instance of the distributed instance, the distributed instance is created.

Before you call this operation, make sure that the following requirements are met:

  • The existing instance must be a performance-enhanced instance of ApsaraDB for Redis Enterprise Edition (Tair). For more information, see Performance-enhanced instances.
  • If the existing instance is a cluster instance, the direct connect mode must be disabled for the existing 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateGlobalDistributeCache

The operation that you want to perform. Set the value to CreateGlobalDistributeCache.

SeedSubInstanceId String Yes r-bp1zxszhcgatnx****

The ID of the existing instance.

RegionId String No cn-hangzhou

The region ID of the existing instance.

Response parameters

Parameter Type Example Description
GlobalInstanceId String gr-bp14rkqrhac****

The ID of the distributed instance.

RequestId String E681E498-5A0D-44F2-B1A7-912DC3******

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=CreateGlobalDistributeCache
&SeedSubInstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<CreateGlobalDistributeCacheResponse>
      <GlobalInstanceId>gr-bp14rkqrhac****</GlobalInstanceId>
      <RequestId>E681E498-5A0D-44F2-B1A7-912DC3******</RequestId>
</CreateGlobalDistributeCacheResponse>

JSON format

{
	"GlobalInstanceId":"gr-bp14rkqrhac****",
	"RequestId": "E681E498-5A0D-44F2-B1A7-912DC3******"
}

Error codes

For a list of error codes, visit the API Error Center.