文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 创建内存加速规则
更新时间：2024-12-02 GMT+08:00
查看PDF
分享

创建内存加速规则

功能介绍

创建内存加速规则。

接口约束

该接口支持GeminiDB Redis 主备版。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v3/{project_id}/dbcache/rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

dbcache_mapping_id

是

String

内存加速映射ID。

name

是

String

内存加速规则名称。不超过256字符，需要确保在当前映射下唯一。

source_db_schema

是

String

源端数据库。

source_db_table

是

String

源端数据表。

storage_type

是

String

目标数据存储类型。取值为： hash。

target_database

是

String

目标数据库。取值范围： [0-999]。

key_columns

是

Array of strings

映射的key使用的column列表。

value_columns

是

Array of strings

映射的value使用的column列表。

ttl

否

String

key的生存时间。单位:ms。不传该值，默认取2592000000，表示30天。

key_separator

是

String

映射的key分隔符。只允许一个字符。

value_separator

否

String

映射的value分隔符。只允许一个字符。

key_prefix

是

String

键前缀。最长限制1024字符。需确保key_prefix和target_database在当前映射下唯一。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

内存加速规则ID。

请求示例

创建内存加速规则。

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/rule 
 
{ 
  "dbcache_mapping_id" : "e6f8526c-8b9c-4811-9218-4d2d7c1ddde1", 
  "name" : "mysql_a1-to-redis_01", 
  "source_db_schema" : "test", 
  "source_db_table" : "students_info_t", 
  "storage_type" : "hash", 
  "target_database" : "0", 
  "key_columns" : [ "sno", "sname" ], 
  "value_columns" : [ "sno", "sname", "age" ], 
  "ttl" : "-1", 
  "key_separator" : ":", 
  "key_prefix" : "prefix1" 
}

响应示例

状态码： 200

Success.

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

状态码

请参见状态码。

错误码

请参见状态码。

父主题： 实例管理

相关文档