功能介绍
使用标签过滤实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2.0/{project_id}/publicips/resource_instances/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
tags |
否 |
包含标签,最多包含10个key。 每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。 Key不能重复,同一个key中values不能重复。 |
|
limit |
否 |
Integer |
查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1 最小值:1 最大值:1000 |
offset |
否 |
Integer |
索引位置, 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数 最小值:0 |
action |
是 |
String |
操作标识(仅限于filter,count):filter(过滤),count(查询总条数) 如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。 枚举值:
|
matches |
否 |
搜索字段,key为要匹配的字段,当前仅支持resource_name。value为匹配的值。此字段为固定字典值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
resource对象列表 |
|
total_count |
Integer |
总记录数 |
请求示例
-
action为filter时请求体。
{ "offset" : 0, "limit" : 100, "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
-
action为count时请求体。
{ "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
响应示例
状态码: 200
GET操作正常返回
{ "total_count" : 1000, "resources" : [ { "resource_detail" : null, "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "value" : "value1", "key" : "key1" }, { "value" : "value1", "key" : "key2" } ] } ] }
状态码
状态码 |
描述 |
---|---|
200 |
GET操作正常返回 |
错误码
请参见错误码。