Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Querying Memory Acceleration Mappings and Details

Updated on 2025-12-04 GMT+08:00

View PDF

Querying Memory Acceleration Mappings and Details

Function

This API is used to query the memory mapping list and details based on specified conditions.

Constraints

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

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:listDBCacheMappings	List	-	-	nosql:instance:listDBCacheMappings	-

URI

GET /v3/{project_id}/dbcache/mappings

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
id	No	String	Definition Mapping ID, which can be obtained by calling the API for querying the memory mapping list and details. Constraints N/A Range N/A Default Value N/A
name	No	String	Definition Mapping name. If you enter a name starting with an asterisk (), fuzzy search results are returned. If you enter a valid name, an exact result is returned. Constraints* N/A Range N/A Default Value N/A
source_instance_id	No	String	Definition Source instance ID Constraints N/A Range N/A Default Value N/A
source_instance_name	No	String	Definition Source instance name. If you enter a name starting with an asterisk (), fuzzy search results are returned. If you enter a valid name, an exact result is returned. Constraints* N/A Range N/A Default Value N/A
target_instance_id	No	String	Definition Target instance ID Constraints N/A Range N/A Default Value N/A
target_instance_name	No	String	Definition Target instance name. If you enter a name starting with an asterisk (), fuzzy search results are returned. If you enter a valid name, an exact result is returned. Constraints* N/A Range N/A Default Value N/A
offset	No	Integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be a non-negative integer. Range ≥ 0 Default Value 0: The query starts from the first data record.
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1–100 Default Value 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records Range N/A
dbcache_mappings	Array of objects in Table 5	Definition Memory mapping information Range N/A

**Table 5** QueryDBCacheMappingResponse
Parameter	Type	Description
id	String	Definition Memory acceleration mapping ID Range N/A
name	String	Definition Memory mapping name Range N/A
source_instance_id	String	Definition Source instance ID Range N/A
source_instance_name	String	Definition Source instance name Range N/A
target_instance_id	String	Definition Target instance ID Range N/A
target_instance_name	String	Definition Target instance name Range N/A
status	String	Definition Memory mapping relationship Range normal: A memory mapping is normal. creating: A memory mapping is being created. createfail: A memory mapping failed to be created. deleting: A memory mapping is being deleted. stopped: A memory mapping is stopped. deleted: A memory mapping is deleted.
created	String	Definition Time when a memory mapping was created Range N/A
updated	String	Definition Last time when a memory mapping was changed Range N/A
rule_count	Integer	Definition Number of rules in a memory mapping Range N/A

Example Requests

Querying the first 10 memory mappings

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/mappings?offset=0&limit=10

Example Responses

Status code: 200

Successful response

{ 
  "total_count" : 1, 
  "dbcache_mappings" : [ { 
    "id" : "0231e002-d278-4df8-815c-8284164168e5", 
    "name" : "dbcache_rule_01", 
    "source_instance_id" : "d8e6ca5a624745bcb546a227aa3ae1cfin01", 
    "target_instance_id" : "9136fd2a9fcd405ea4674276ce36dae8in12", 
    "source_instance_name" : "source_name", 
    "target_instance_name" : "target_name", 
    "status" : "normal", 
    "rule_count" : 10, 
    "created" : "2024-01-17T07:05:52", 
    "updated" : "2024-01-20T08:07:02" 
  } ] 
}