查询资源列表
功能介绍
查询资源列表
URI
POST /v1/{project_id}/{resource_type}/resource-instances/filter
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID 最小长度：32 最大长度：32 |
|
resource_type |
是 |
String |
资源类型 最小长度：4 最大长度：32 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token 最小长度：1 最大长度：65535 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
without_any_tag |
否 |
Boolean |
不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 |
|
tags |
否 |
Array of Tag objects |
包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度：0 - 50 |
|
tags_any |
否 |
Array of Tag objects |
包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度：0 - 50 |
|
not_tags |
否 |
Array of Tag objects |
不包含标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度：0 - 50 |
|
not_tags_any |
否 |
Array of Tag objects |
不包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度：0 - 50 |
|
sys_tags |
否 |
Array of Tag objects |
仅op_service权限可以使用此字段做资源实例过滤条件。 目前TMS调用时只包含一个tag结构体。 key：_sys_enterprise_project_id value：企业项目id列表 目前TMS调用时，key下面只包含一个value。0表示默认企业项目 sys_tags和租户标签过滤条件（without_any_tag 、tags、tags_any、not_tags、not_tags_any）不能同时使用 无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。 数组长度：0 - 1000 |
|
matches |
否 |
Array of Match objects |
搜索字段,key为要匹配的字段，如resource_name等。value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写），如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况，因此此类情况返回空列表）。resource_id为精确匹配 数组长度：0 - 1000 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
Array of resources objects |
资源列表 数组长度：0 - 1000 |
|
total_count |
Integer |
资源总数 最小值：0 最大值：1000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID 最小长度：36 最大长度：45 |
|
resource_detail |
String |
资源详情,默认为空。 最小长度：0 最大长度：100 |
|
resource_name |
String |
资源名称 最小长度：36 最大长度：45 |
|
tags |
Array of ResourceTag objects |
标签列表，没有标签默认为空数组 数组长度：0 - 1000 |
|
sys_tags |
Array of ResourceTag objects |
仅op_service权限才可以可以获取此字段 数组长度：0 - 1000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
键。最大长度128个字符，可以包含任意语种字母， 数字，空格和_ . : = + - @，但首尾不能含有空格, 不能以_sys_开头。 最小长度：1 最大长度：128 |
|
value |
String |
值。每个值最大长度255个字符，可以包含任意语种字母， 数字，空格和_.:/=+-@。 最小长度：0 最大长度：255 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
状态码 最小长度：3 最大长度：3 |
|
error_code |
String |
错误码 最小长度：12 最大长度：12 |
|
error_msg |
String |
错误信息 最小长度：1 最大长度：65535 |
|
message |
String |
错误详细信息 最小长度：0 最大长度：65535 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
状态码 最小长度：3 最大长度：3 |
|
error_code |
String |
错误码 最小长度：12 最大长度：12 |
|
error_msg |
String |
错误信息 最小长度：1 最大长度：65535 |
|
message |
String |
错误详细信息 最小长度：0 最大长度：65535 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
状态码 最小长度：3 最大长度：3 |
|
error_code |
String |
错误码 最小长度：12 最大长度：12 |
|
error_msg |
String |
错误信息 最小长度：1 最大长度：65535 |
|
message |
String |
错误详细信息 最小长度：0 最大长度：65535 |
请求示例
无
响应示例
状态码： 400
请求参数校验不通过
{
"code" : 400,
"error_code" : "BCS.03400001",
"error_msg" : "Invalid request.",
"message" : "unmarshal request data error"
}
状态码： 401
鉴权失败
{
"code" : 401,
"error_code" : "BCS.03401001",
"error_msg" : "Authorization failed.",
"message" : "request token is not valid"
}
状态码： 500
服务内部执行错误
{
"code" : 500,
"error_code" : "BCS.03500001",
"error_msg" : "Internal error.",
"message" : "project [xxx] node [xxx] get service bearer user token error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求参数校验不通过 |
|
401 |
鉴权失败 |
|
500 |
服务内部执行错误 |
错误码
请参见错误码。
