更新时间:2024-07-18 GMT+08:00
分享

查询资源实例数量

功能介绍

根据标签查询资源实例数量。

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/{resource_type}/resource-instances/count

表1 参数说明

名称

类型

是否必选

说明

project_id

String

项目ID,可以通过获取项目ID获取项目ID。

resource_type

String

  • 功能说明:资源类型。
  • 取值范围:vpn-gateway,customer-gateway,vpn-connection,p2c-vpn-gateways。

请求消息

  • 请求参数
    表2 请求参数

    名称

    类型

    是否必选

    描述

    without_any_tag

    Boolean

    • 功能说明:该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。该字段为false或者未提供该参数时,该条件不生效,即返回所有资源或按"tags","matches"等条件过滤。

    tags

    Array of Tag objects

    • 功能说明:标签列表。
    • 约束:最多填写20个。

    matches

    Array of Match objects

    • 功能说明:搜索字段,包含key和value。key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值。
    表3 Tag

    名称

    类型

    是否必选

    描述

    key

    String

    • 功能说明:标签的键。
    • 取值范围:1-128个字符。

    values

    Array of String

    • 功能说明:标签的值列表。如果values为空列表,则表示any_value。value之间为或的关系。
    • 取值范围:0-255个字符。
    • 约束:最多填写20个。
    表4 Match

    名称

    类型

    是否必选

    描述

    key

    String

    • 功能说明:匹配的键。
    • 取值范围:resource_name。

    value

    String

    • 功能说明:匹配的值。
    • 取值范围:0-255个字符。
  • 请求样例
    POST https://{Endpoint}/v5/{project_id}/{resource_type}/resource-instances/count
    {
        "tags": [{
                "key": "key1",
                "values": [
                    "value1",
                    "value2"
                ]
            },
            {
                "key": "key2",
                "values": [
                    "value1",
                    "value2"
                ]
            }
        ],
        "matches": [{
            "key": "resource_name",
            "value": "resource1"
        }],
        "without_any_tag": "false"
    }

响应消息

  • 响应参数

    返回状态码为 200: 查询成功。

    表5 响应Body参数列表

    名称

    类型

    描述

    total_count

    Integer

    总记录数。

  • 响应样例
    {
        "total_count": 1000
    }

状态码

请参见状态码

相关文档