# 查询资源实例-QueryingResourcesbyTag #### 接口说明 根据标签查询指定的数据库实例。 #### 约束说明 一个文档数据库实例具有20个标签配额，且标签key唯一。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListInstancesByTags)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:listAll | list | - | - | dds:instance:list | - | #### URI - URI格式 POST /v3/{project_id}/instances/action - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/action 表1请求参数 | 名称 | 类型 | IN | 是否必选 | 描述 | |:---|:---|:---|:---|:---| | X-Auth-Token | string | header | 是 | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | project_id | string | path | 是 | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 - 参数说明 表2参数说明 | 名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | offset | String | 否 | **参数解释：** 索引位置偏移量，表示从第一条数据偏移offset条数据后开始查询。 **约束限制：** - "action"值为"count"时，不传该参数。 - "action"值为"filter"时，取值必须为数字，不能为负数。 **取值范围：** 不涉及。 **默认取值：** 0。默认取0值，表示从第一条数据开始查询。 | | limit | String | 否 | **参数解释：** 查询记录数。 **约束限制：** - "action"值为"count"时，不传该参数。 - "action"值为"filter"时，取值范围：1\~100。 **取值范围：** 1\~100。 **默认取值：** 100。不传该参数时，默认查询前100条实例信息。 | | action | String | 是 | **参数解释：** 操作标识。 **约束限制：** - 取值为"filter"，表示根据标签过滤条件查询实例。 - 取值为"count"，表示仅返回总记录数，禁止返回其他字段。 **取值范围：** - count - filter **默认取值：** 不涉及。 | | matches | Array of objects | 否 | **参数解释：** 搜索字段。 **约束限制：** - 该字段值为空，表示不按照实例名称或实例ID查询。 - 该字段值不为空，具体值请参见[表4]。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | tags | Array of objects | 否 | **参数解释：** 包含标签，详情请参见[表3]。 **约束限制：** 最多包含20个key。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3tags字段数据结构说明 | 名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | key | String | 是 | **参数解释：** 标签键。 **约束限制：** - key不能为空，长度1\~128个半角字符。 - 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 - _sys_开头属于系统标签，租户不能输入。 说明： 搜索时不对该参数做字符集校验。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | values | Array of strings | 是 | **参数解释：** 标签值列表。 **约束限制：** - 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 - 可以为空（empty or null），长度0\~255个半角字符。 **取值范围：** 不涉及。 **默认取值：** 如果values为空列表，则表示查询任意value。value之间为或的关系。 | 表4matches字段数据结构说明 | 名称 | 参数类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | key | String | 是 | **参数解释：** 搜索字段名。 **约束限制：** 不涉及。 **取值范围：** - instance_name：表示按实例名称匹配查询。 - instance_id：表示按实例ID匹配查询。 **默认取值：** 不涉及。 | | value | String | 是 | **参数解释：** 待匹配的实例名称或实例ID，可以调用"[查询实例列表](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求示例 - 根据标签，按实例名称查询1\~100条指定实例信息 ``` { "offset": "0", "limit": "100", "action": "filter", "matches": [ { "key": "instance_name", "value": "test-single" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } ``` - 按照实例名称或按实例ID查询总记录数 ``` { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "instance_name", "value": "test-single" }, { "key": "instance_id", "value": "958693039f284d6ebfb177375711072ein02" } ] } ``` #### 响应消息 - 参数说明 表5参数说明 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | instances | Array of objects | **参数解释：** 实例列表。详情请参见[表6]。 **取值范围：** 不涉及。 | | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | 表6instance字段数据结构说明 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释：** 实例ID，可以调用"[查询实例列表](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **取值范围：** 不涉及。 | | instance_name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。 | | tags | Array of objects | **参数解释：** 标签列表。如果没有标签，默认为空数组。详情请参见[表7]。 **取值范围：** 不涉及。 | 表7tags字段数据结构说明 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** - key不能为空，长度1\~128个半角字符。 - 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 - _sys_开头属于系统标签，租户不能输入。 - 字符集：0-9，A-Z，a-z，"_"，"-"，中文。 | | value | String | **参数解释：** 标签值。 **取值范围：** - 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @。 - 可以为空（empty or null），长度0\~255个半角字符。 - 字符集：0-9，A-Z，a-z，"_"，"."，"-"，中文。 | - 响应示例 根据标签返回指定实例： ``` { "instances": [ { "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02", "instance_name": "test-single", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ] } ``` 返回总记录数： ``` { "total_count": 4 } ``` #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。