功能介绍
使用标签过滤查询租户下资源的实例。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/{resource_type}/resource_instances/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
resource_type |
是 |
String |
资源类型，值为：endpoint_service或endpoint。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
Content-Type |
否 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json， 如果API是对象、 镜像 上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
tags |
否 |
包含标签，最多包含10个key，每个key下面的value最多10个， 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复， 同一个key中values不能重复。结果返回包含所有标签的资源列表， key之间是与的关系，key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 |
|
|
tags_any |
否 |
包含任意标签，最多包含10个key，每个key下面的value最多10个， 每个key对应的value可以为空数组但结构体不能缺失。 Key不能重复，同一个key中values不能重复。 结果返回包含标签的资源列表，key之间是或的关系，key、value结构中value是或的关系。 无过滤条件时返回全量数据。 |
|
|
not_tags |
否 |
不包含标签，最多包含10个key，每个key下面的value最多10个， 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复， 同一个key中values不能重复。结果返回不包含标签的资源列表，key之间是与的关系， key、value结构中value是或的关系。 无过滤条件时返回全量数据。 |
|
|
not_tags_any |
否 |
不包含任意标签，最多包含10个key，每个key下面的value最多10个， 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复， 同一个key中values不能重复。结果返回不包含标签的资源列表， key之间是与的关系，key、value结构中value是或的关系。 无过滤条件时返回全量数据。 |
|
|
sys_tags |
否 |
系统标签， |
|
|
limit |
否 |
String |
查询记录数（action为count时无此参数）如果action为filter默认为1000， limit最多为1000，不能为负数，最小值为1。 |
|
offset |
否 |
String |
索引位置，偏移量（action为count时无此参数）从第一条数据偏移offset条数据后开始查询， 如果action为filter默认为0（偏移0条数据，表示从第一条数据开始查询）， 必须为数字，不能为负数。 |
|
action |
是 |
String |
操作标识（仅限于filter，count）：filter（过滤）， count(查询总条数)如果是filter就按照过滤条件查询， 如果是count，只需要返回总条数，禁止返回其他字段。 |
|
matches |
否 |
搜索字段，key为要匹配的字段，如resource_name等。value为匹配的值。 key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写）， 如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况， 因此此类情况返回空列表）。resource_id为精确匹配。 第一期只做resource_name，后续再扩展。 |
|
|
without_any_tag |
否 |
Boolean |
默认为false，取值【true/false】,当withoutAnyTag=true， 忽略tags、tagsAny、notTags、notTagsAny参数校验。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
键。 最大长度127个unicode字符。key不能为空。(搜索时不对此参数做字符集校)， key不能为空或者空字符串，不能为空格，校验和使用之前先trim前后半角空格。 最小长度：1 最大长度：36 |
|
values |
是 |
Array of strings |
值列表。 每个值最大长度255个unicode字符，校验和使用之前先trim前后半角空格。 value可为空数组但不可缺省。如果values为空列表，则表示any_value（查询任意value）。 value之间为或的关系。(搜索时不对此参数做字符集校验，只做长度校验)。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resources |
资源实例详情 |
|
|
total_count |
Integer |
总记录数。 最小值：1 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
资源ID，Endpoint Service ID或Endpoint ID。 |
|
tags |
标签列表。 |
|
|
resource_name |
String |
资源名称，资源没有名称时，返回ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
键。 最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。 最小长度：1 最大长度：36 |
|
value |
String |
值。 每个值最大长度43个unicode字符，可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。 最小长度：1 最大长度：43 |
状态码： 400
状态码： 401
状态码： 403
状态码： 404
状态码： 405
状态码： 406
状态码： 407
状态码： 408
状态码： 409
状态码： 500
状态码： 501
状态码： 502
状态码： 503
状态码： 504
请求示例
-
使用标签查询 终端节点
POST https://{endpoint}/v1/{project_id}/endpoint/resource_instances/action action为filter时请求体 { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "not_tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } -
查询终端节点服务资源总数
https://{endpoint}/v1/{project_id}/endpoint_service/ resource_instances/action action为count时请求体 { "action": "count", "not_tags": [ { "key": "key1", "values": [ "value1", "*value2" ] } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "not_tags_any": [ { "key": "key1", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
响应示例
状态码： 200
服务器已成功处理了请求
– action为filter时响应体
{
"resources": [
{
"resource_id": "cdfs_cefs_wesas_12_dsad",
"resource_name": "resource1",
"tags": [
{
"key": "key1", "value": "value1"
},
{
"key": "key2", "value": "value1"
}
]
}
],
"total_count": 1000
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
服务器已成功处理了请求 |
|
400 |
服务器未能处理请求 |
|
401 |
被请求的页面需要用户名和密码 |
|
403 |
对被请求页面的访问被禁止 |
|
404 |
服务器无法找到被请求的页面 |
|
405 |
请求中指定的方法不被允许 |
|
406 |
服务器生成的响应无法被客户端所接受 |
|
407 |
用户必须首先使用代理服务器进行验证，这样请求才会被处理 |
|
408 |
请求超出了服务器的等待时间 |
|
409 |
由于冲突，请求无法被完成 |
|
500 |
请求未完成。服务异常 |
|
501 |
请求未完成。服务器不支持所请求的功能 |
|
502 |
请求未完成。服务器从上游服务器收到一个无效的响应 |
|
503 |
请求未完成。系统暂时异常 |
|
504 |
网关超时 |
错误码
请参见错误码。
