更新时间:2025-07-29 GMT+08:00

创建内存加速规则

功能介绍

创建内存加速规则。

接口约束

该接口支持GeminiDB Redis 主备版。

URI

POST https://{Endpoint}/v3/{project_id}/dbcache/rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户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" 
}

状态码

请参见状态码

错误码

请参见状态码