# 查询内存加速规则列表和详情 - QueryingMemoryMappingRulesandDetails #### 功能介绍 查询内存加速规则列表和详情。 #### 接口约束 该接口支持GeminiDB Redis 主备版。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowPasswordlessConfig)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql:instance:listDBCacheRules | List | - | - | nosql:instance:listDBCacheRules | - | #### URI GET /v3/{project_id}/dbcache/rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | dbcache_mapping_id | 是 | String | **参数解释：** 内存加速映射ID。获取方法请参见[查询内存加速映射列表和详情 - QueryingtheMemoryMappingListandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0068.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | 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。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | dbcache_mapping_id | String | **参数解释：** 内存加速映射ID。 **取值范围：** 不涉及。 | | rules | Array of [表5]objects | **参数解释：** 内存加速规则详情。 | 表5QueryDBCacheRuleResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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/rules?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" : ":", "value_separator": null, "key_prefix": "test|user|key|value" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。