Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Creating a Memory Mapping
Updated on 2025-09-16 GMT+08:00
View PDF
Share

Creating a Memory Mapping

Function

This API is used to create a memory mapping.

Constraints

This API can be used only on primary/standby GeminiDB Redis instances.

URI

POST /v3/{project_id}/dbcache/mapping

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source_instance_id

Yes

String

Explanation:

ID of a source instance for which a memory mapping is created.

Constraints:

Currently, RDS for MySQL and TaurusDB instances are supported.

Values:

N/A

Default value:

N/A

target_instance_id

Yes

String

Explanation:

ID of a destination instance for which a memory mapping is created

Constraints:

Currently, only primary/standby GeminiDB Redis instances are supported.

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

ID of a memory mapping task to be created

Values:

N/A

Example Request

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/mapping 
 
{ 
  "source_instance_id": "356cf333ab77413f9d2526605227be08in01" ,
  "target_instance_id": "2bb234c7175c400aab91de7c62174c0ein12" 
}

Example Response

Status code: 202

Accepted.

{ 
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" 
}

Status Codes

See Status Codes.

Error Codes

See Status Codes.

Parent topic: Instances