# 查询内存加速映射列表和详情 - QueryingtheMemoryMappingListandDetails #### 功能介绍 根据指定条件查询内存加速映射关系列表和详情。 #### 接口约束 该接口支持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:listDBCacheMappings | List | - | - | nosql:instance:listDBCacheMappings | - | #### URI GET /v3/{project_id}/dbcache/mappings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释：** 映射ID，可以调用"查询内存加速映射列表和详情"接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name | 否 | String | **参数解释：** 映射名称。名称以"\**"起始，表示按照"\**"后面的值模糊匹配，否则，按照实际填写的名称精确匹配查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | source_instance_id | 否 | String | **参数解释：** 源实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | source_instance_name | 否 | String | **参数解释：** 源实例名称。名称以"\**"起始，表示按照"\**"后面的值模糊匹配，否则，按照实际填写的名称精确匹配查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | target_instance_id | 否 | String | **参数解释：** 目标实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | target_instance_name | 否 | String | **参数解释：** 目标实例名称。名称以"\**"起始，表示按照"\**"后面的值模糊匹配，否则，按照实际填写的名称精确匹配查询。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 非负整数。 **取值范围：** \>=0。 **默认取值：** 0。偏移0条数据，表示从第一条数据开始查询。 | | limit | 否 | Integer | **参数解释：** 查询个数上限值。 **约束限制：** 不涉及。 **取值范围：** 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_mappings | Array of [表5 QueryDBCacheMappingResponse] objects | **参数解释：** 内存加速映射信息。 | 表5QueryDBCacheMappingResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 内存加速映射ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 内存加速映射名称。 **取值范围：** 不涉及。 | | source_instance_id | String | **参数解释：** 源实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **取值范围：** 不涉及。 | | source_instance_name | String | **参数解释：** 源实例名称。 **取值范围：** 不涉及。 | | target_instance_id | String | **参数解释：** 目标实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **取值范围：** 不涉及。 | | target_instance_name | String | **参数解释：** 目标实例名称。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 内存加速映射状态。 **取值范围：** - normal： 表示内存加速映射正常。 - creating： 表示内存加速映射创建中。 - createfail： 表示内存加速映射创建失败。 - deleting： 表示内存加速映射解除中。 - stopped： 表示内存加速映射停止。 - deleted： 表示内存加速映射已解除。 | | created | String | **参数解释：** 内存加速映射创建时间。UTC时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | updated | String | **参数解释：** 内存加速映射最新变更的时间。UTC时间。格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | rule_count | Integer | **参数解释：** 该内存加速映射下的规则数量。 **取值范围：** 不涉及。 | #### 请求示例 查询前10个内存加速映射信息。 ``` GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/mappings?offset=0&limit=10 ``` #### 响应示例 **状态码： 200** Success. ``` { "total_count" : 1, "dbcache_mappings" : [ { "id" : "0231e002-d278-4df8-815c-8284164168e5", "name" : "dbcache_rule_01", "source_instance_id" : "d8e6ca5a624745bcb546a227aa3ae1cfin01", "target_instance_id" : "9136fd2a9fcd405ea4674276ce36dae8in12", "source_instance_name" : "source_name", "target_instance_name" : "target_name", "status" : "normal", "rule_count" : 10, "created" : "2024-01-17T07:05:52", "updated" : "2024-01-20T08:07:02" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。