查询资源实例 - QueryinganInstancebyTag
功能介绍
根据标签查询指定的数据库实例。
该接口计划下线，建议及时切换到新接口查询资源实例 - QueryinganInstancebyTag。
接口约束
- 该接口支持如下数据库实例
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
- 一个数据库实例具有20个标签配额，且标签key唯一。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql::listResourcesByTags
List
-
-
- nosql:instance:list
- nosql:tag:list
-
URI
- URI格式
- URI样例
POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource_instances/action - 参数说明
表1 参数说明 名称
是否必选
描述
project_id
是
参数解释：
租户在某一region下的project ID。获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
- 参数说明
表2 参数说明 名称
是否必选
参数类型
描述
offset
否
String
参数解释：
索引位置偏移量，表示从第一条数据偏移offset条数据后开始查询。
约束限制：
- “action”值为“count”时，不传该参数。
- “action”值为“filter”时，取值必须为数字，不能为负数。默认取0值，表示从第一条数据开始查询。
取值范围：
大于或等于0。
默认取值：
0,表示从第一条数据开始查询。
limit
否
String
参数解释：
查询记录数。
约束限制：
- “action”值为“count”时，不传该参数。
- “action”值为“filter”时，取值范围：1~100。
取值范围：
1~100。
默认取值：
不传该参数时，默认查询前100条实例信息。
action
是
String
参数解释：
操作标识。
约束限制：
不涉及。
取值范围：
- filter：表示根据标签过滤条件查询实例。
- count：表示仅返回总记录数，禁止返回其他字段。
默认取值：
不涉及。
matches
否
Array of 表4 objects
参数解释：
搜索字段。
约束限制：
不涉及。
取值范围：
- 该字段值为空，表示不按照实例名称或实例ID查询。
- 该字段值不为空。
默认取值：
不涉及。
tags
否
Array of 表3 objects
参数解释：
包含标签。
约束限制：
最多包含20个key。
取值范围：
不涉及。
默认取值：
不涉及。
表3 tags字段数据结构说明 名称
是否必选
参数类型
描述
key
是
String
参数解释：
标签键。
约束限制：
最大长度36个unicode字符，key不能为空或者空字符串，不能为空格，校验和使用之前先排除前后半角空格。搜索时不对该参数做字符集校验。
取值范围：
不涉及。
默认取值：
不涉及。
values
是
Array of strings
参数解释：
标签值列表。
约束限制：
最大长度43个unicode字符，不能为空格，校验和使用之前先排除前后半角空格。如果values为空列表，则表示查询任意value。value之间为或的关系。
取值范围：
不涉及。
默认取值：
不涉及。
- 请求体样例
{ "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "instance_name", "value": "test-af07" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ] }查询总记录数：{ "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "instance_name", "value": "test-af07" }, { "key": "instance_id", "value": "958693039f284d6ebfb177375711072ein06" } ] }
响应消息
- 正常响应要素说明
表5 要素说明 名称
参数类型
描述
instances
Array of objects
参数解释：
实例列表。
取值范围：
不涉及。
total_count
Integer
参数解释：
总记录数。
取值范围：
不涉及。
表6 instance字段数据结构说明 名称
参数类型
描述
instance_id
String
参数解释：
实例ID。
取值范围：
不涉及。
instance_name
String
参数解释：
实例名称。
取值范围：
不涉及。
tags
Array of 表7 objects
参数解释：
标签列表。如果没有标签，默认为空数组。
取值范围：
不涉及。
- 正常响应样例
{ "instances": [ { "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin06", "instance_name": "test-single", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ] }返回总记录数：
{ "total_count": 4 }
- 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
