查询ACL资源实例列表
功能介绍
使用标签过滤查询ACL实例。
URI
POST /v3/{project_id}/firewalls/resource-instances/filter
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
功能说明：查询记录数 取值范围：1-1000 约束：默认为1000 |
offset |
否 |
Integer |
功能说明：索引位置， 从第一条数据偏移offset条数据后开始查询 约束：默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
matches |
否 |
Array of Match objects |
功能说明：搜索字段，key为要匹配的字段，value为匹配的值 约束：key为固定字典值，不能包含重复的key或不支持的key，当前key仅支持resource_name |
tags |
否 |
Array of ListTag objects |
包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失 。 Key不能重复，同一个key中values不能重复。 结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
resources |
Array of ListResourceResp objects |
资源列表 |
total_count |
Integer |
资源数量 |
request_id |
String |
请求ID |
参数 |
参数类型 |
描述 |
|---|---|---|
resource_id |
String |
资源ID |
resource_detail |
Object |
资源详情。 资源对象，用于扩展。默认为空 |
resource_name |
String |
资源名称，资源没有名称时默认为空字符串. |
tags |
Array of ResourceTag objects |
标签列表，没有标签默认为空数组 |
参数 |
参数类型 |
描述 |
|---|---|---|
key |
String |
功能说明：标签键 约束：同一资源的key值不能重复。 最大长度：128 |
value |
String |
功能说明：标签值 最大长度：255 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID |
error_msg |
String |
错误消息 |
error_code |
String |
错误码 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID |
error_msg |
String |
错误消息 |
error_code |
String |
错误码 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID |
error_msg |
String |
错误消息 |
error_code |
String |
错误码 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID |
error_msg |
String |
错误消息 |
error_code |
String |
错误码 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
request_id |
String |
请求ID |
error_msg |
String |
错误消息 |
error_code |
String |
错误码 |
请求示例
过滤查询ACL资源实例列表，用tags和matches过滤，限制返回100条数据，从第一条数据开始查询。
https://{{Endpoint}}/v3/{project_id}/firewalls/resource-instances/filter?limit=100&offset=0
{
"tags" : [ {
"key" : "key1",
"values" : [ "value1" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "network_aclv3_test"
} ]
}
响应示例
状态码： 200
请求正常返回
{
"resources" : [ {
"resource_id" : "55046c0b-f38e-4bc4-988a-06529b34a7db",
"resource_detail" : "",
"resource_name" : "network_aclv3_test",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ]
}, {
"resource_id" : "1828c600-793d-4570-987b-ac59f3ef0734",
"resource_detail" : "",
"resource_name" : "network_aclv3_test",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key5",
"value" : "value5"
} ]
} ],
"request_id" : "2d9cef8c-4e17-40bc-9111-f3fc97b97294",
"total_count" : 2
}
状态码
状态码 |
描述 |
|---|---|
200 |
请求正常返回 |
400 |
参数非法 |
401 |
鉴权失败 |
403 |
权限不足 |
404 |
资源未找到 |
500 |
系统异常 |
错误码
请参见错误码。
