查询资源实例 - ListResourceByTags
功能介绍
该API用于获取过滤后的资源实例列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
asm:mesh:listResourcesByTag
List
-
g:TagKeys
-
-
URI
POST /v2/{projectid}/{resourcetype}/resource-instances/filter
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
projectid |
是 |
String |
项目ID。 |
|
resourcetype |
是 |
String |
资源类型，目前仅支持"asm-mesh" |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
String |
限制数量 |
|
offset |
否 |
String |
偏移量 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。 |
|
Content-Type |
是 |
String |
消息体的类型（格式）。 取值范围： |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
without_any_tag |
否 |
Boolean |
不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”字段。该字段为false或者未提供该参数时，该条件不生效，即返回所有资源或按"tags","matches"等条件过滤。 |
|
tags |
否 |
Array of resource_tag objects |
包含标签，最多包含20个key，每个key下面的value最多20个，每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 |
|
matches |
否 |
Array of match objects |
搜索字段，key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name需要实现前缀搜索，如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况，因此此类情况返回空列表）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
Array of ResInstance objects |
资源实例列表 |
|
total_count |
Integer |
资源实例总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID，即网格ID |
|
resource_name |
String |
资源名称，即网格名称 |
|
tags |
Array of resource_tag objects |
标签列表 |
|
sys_tags |
Array of resource_tag objects |
系统标签列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
键。最大长度128个字符。 key需要满足3.1 KEY字符集规范 |
|
value |
String |
值。每个值最大长度255个字符， value需要满足3.2 VALUE字符集规范 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误码 |
|
errorMsg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误码 |
|
errorMsg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功获取到过滤后的资源实例列表 |
|
400 |
参数错误，获取资源实例列表失败 |
|
500 |
内部错误 |
错误码
请参见错误码。
