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

查询内存加速规则列表和详情

功能介绍

查询内存加速规则列表和详情。

接口约束

该接口支持GeminiDB Redis 主备版。

调试

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

URI

GET /v3/{project_id}/dbcache/rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

dbcache_mapping_id

是

String

内存加速映射ID。

rule_id

否

String

内存加速规则ID。

rule_name

否

String

内存加速规则名称。名称以“”起始，表示按照“”后面的值模糊匹配，否则，按照实际填写的名称精确匹配查询。

source_db_schema

否

String

源端数据库名。名称以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的名称精确匹配查询。

source_db_table

否

String

源端数据表名。名称以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的名称精确匹配查询。

offset

否

String

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。取值必须为数字，不能为负数。

limit

否

String

查询个数上限值。取值范围：1~100。不传该参数时，默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

总记录数。

dbcache_mapping_id

String

内存加速映射ID。

rules

Array of 表5objects

内存加速规则详情。
表5 QueryDBCacheRuleResponse

参数

参数类型

描述

id

String

内存加速规则ID。

name

String

内存加速规则名称。

status

String

内存加速规则状态。

  • normal,正常;
  • createfail, 创建失败;

source_db_schema

String

源端数据库。

source_db_table

String

源端数据表。

storage_type

String

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

target_database

String

目标数据库。

key_columns

Array of strings

映射的key使用的column列表。

value_columns

Array of strings

映射的value使用的column列表。

ttl

String

key的生存时间。单位:ms。不传该值，默认取-1，表示永久存储。

key_separator

String

映射的key分隔符。

value_separator

String

映射的value分隔符。

key_prefix

String

键前缀。

请求示例

查询映射ID为1094e5d3-c140-4095-9b13-242de267c175下的前10条内存加速规则记录。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/rule?offset=0&limit=10 
 
{ 
  "dbcache_mapping_id" : "1094e5d3-c140-4095-9b13-242de267c175" 
}

响应示例

状态码： 200

Success.

{ 
  "total_count" : 1, 
  "dbcache_mapping_id" : "0231e002-d278-4df8-815c-8284164168e5", 
  "rules" : [ { 
    "id" : "0231e002-d278-4df8-815c-8284164168e5", 
    "name" : "dbcache_rule_01", 
    "source_db_schema" : "test", 
    "source_db_table" : "student_t", 
    "status" : "normal", 
    "storage_type" : "hash", 
    "target_database" : "0", 
    "key_columns" : [ "sno", "sname", "age" ], 
    "value_columns" : [ "sno", "sname", "age" ], 
    "ttl" : "10000", 
    "key_separator" : ":", 
    "created" : "2024-01-17T07:05:52", 
    "updated" : "2024-01-20T08:07:02" 
  } ] 
}

状态码

请参见状态码。

错误码

请参见状态码。

父主题： 实例管理

相关文档