Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Modifying a Memory Acceleration Rule

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

View PDF

Modifying a Memory Acceleration Rule

Function

This API is used to modify a memory acceleration rule.

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:updateDBCacheRule	write	-	-	nosql:instance:updateDBCacheRule	-

URI

PUT /v3/{project_id}/dbcache/rule

**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

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
dbcache_rule_id	Yes	String	Definition ID of a memory acceleration rule Constraints N/A Range N/A Default Value N/A
value_columns	Yes	Array of strings	Definition Columns used by mapped values Constraints N/A Range N/A Default Value N/A
ttl	No	String	Definition Lifetime of a key (unit: ms) Constraints N/A Range N/A Default Value 2592000000: 30 days
value_separator	No	String	Definition Value separator of a mapping Constraints Only one character is allowed. Range N/A Default Value N/A

Response Parameters

None

Example Requests

Updating a memory acceleration rule

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/rule 
 
{ 
  "dbcache_rule_id" : "0231e002-d278-4df8-815c-8284164168e5", 
  "value_columns" : [ "sno", "sname", "age" ], 
  "ttl" : 3000, 
  "value_separator" : "_" 
}