文档首页 > > API参考> API> VPC资源标签管理> 查询VPC资源实例

查询VPC资源实例

分享
更新时间: 2020/06/09 GMT+08:00

功能介绍

使用标签过滤实例。

该类型接口目前在“华北-北京一”“华北-北京四”、“华东-上海一”、“华东-上海二”、“西南-贵阳一”“华南-广州”、“亚太-香港”区域开放。

URI

POST /v2.0/{project_id}/vpcs/resource_instances/action

参数说明请参见表1

表1 参数说明

名称

是否必选

说明

project_id

项目ID,请参见获取项目ID

请求消息

请求参数

表2 请求参数

参数名称

类型

是否必选

说明

tags

Array of tag objects

包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。

limit

String

查询记录数(action为count时无此参数)如果action为filter默认为1000,limit最多为1000,不能为负数,最小值为1

offset

String

(索引位置), 从offset指定的下一条数据开始查询。 查询第一页数据时,不需要传入此参数,查询后续页码数据时,将查询前一页数据时响应体中的值带入此参数(action为count时无此参数)如果action为filter默认为0,必须为数字,不能为负数

action

String

操作标识(仅限于filter,count):filter(过滤),count(查询总条数)

如果是filter就是分页查询,如果是count只需按照条件将总条数返回即可。

matches

Array of match objects

搜索字段,key为要匹配的字段,当前仅支持resource_name。value为匹配的值。此字段为固定字典值。

表3 tag字段数据结构说明

名称

是否必选

参数类型

说明

key

String

键。最大长度127个unicode字符。 key不能为空。(搜索时不对此参数做校验)

values

Array of strings

值列表。每个值最大长度255个unicode字符,如果values为空列表,则表示any_value。value之间为或的关系。

表4 match字段数据结构说明

名称

是否必选

参数类型

说明

key

String

键。当前仅限定为resource_name

value

String

值。每个值最大长度255个unicode字符。

请求样例1:action为filter

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"
            ]
        }
    ]
}

请求样例2:action为count

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"
        }
    ]
}

响应消息

响应参数

表5 响应参数

名称

参数类型

说明

resources

Array of resource objects

resource对象列表,请参见表6

total_count

Integer

总记录数

表6 resource对象

名称

参数类型

说明

resource_id

String

资源ID

resouce_detail

Object

资源详情。 资源对象,用于扩展。默认为空

tags

Array of tag objects

标签列表,没有标签默认为空数组,参见表7

resource_name

String

资源名称,没有默认为空字符串

表7 tag字段数据结构说明

名称

是否必选

参数类型

说明

key

String

键。最大长度127个unicode字符。 key不能为空。(搜索时不对此参数做校验)

value

String

值列表。每个值最大长度255个unicode字符,如果values为空列表,则表示any_value。value之间为或的关系。

响应样例1: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
}
 

响应样例2:action为count

{
       "total_count": 1000
}

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问