更新时间:2024-03-05 GMT+08:00
查询VPC资源实例
功能介绍
使用标签过滤实例。
请求参数
参数名称 |
类型 |
是否必选 |
说明 |
---|---|---|---|
tags |
Array of tag objects |
否 |
包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。 |
limit |
Integer |
否 |
查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1 |
offset |
Integer |
否 |
(索引位置), 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数 |
action |
String |
是 |
操作标识(仅限于filter,count):filter(过滤),count(查询总条数) 如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。 |
matches |
Array of match objects |
否 |
搜索字段,key为要匹配的字段,当前仅支持resource_name。value为匹配的值。此字段为固定字典值。 |
请求示例
- 过滤查询VPC资源实例,action为filter,从第1条数据开始查询,单次查询最多返回100条,用matches和tags过滤查询。
POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action { "offset": "0", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ] }
- 过滤计数VPC资源实例,action为count,用matches和tags过滤计数。
POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
响应参数
响应示例
- action为filter
{ "resources": [ { "resource_detail": null, "resource_id": "cdfs_cefs_wesas_12_dsad", "resource_name": "resouece1", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ], "total_count": 1000 }
- action为count
{ "total_count": 1000 }
状态码
请参见状态码。
错误码
请参考错误码。
父主题: VPC资源标签管理