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

查询配额

功能介绍

查询单租户在VPN服务下的网络资源配额,包括VPN网关配额、对端网关配额、VPN连接配额。

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/vpn/quotas
表1 参数说明

名称

类型

是否必选

说明

project_id

String

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

请求消息

  • 请求参数

    无。

  • 请求样例
    GET https://{Endpoint}/v5/{project_id}/vpn/quotas

响应消息

  • 响应参数

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

    表2 响应Body参数列表

    名称

    类型

    描述

    quotas

    Quotas object

    quotas对象。

    request_id

    String

    请求ID。

    表3 Quotas

    名称

    类型

    描述

    resources

    Array of QuotaInfo objects

    resources对象。

    表4 QuotaInfo

    名称

    类型

    描述

    type

    String

    • 功能说明:根据type过滤查询指定类型的配额。
    • 取值范围:
      • customer_gateway 对端网关。
      • vpn_connection 企业版VPN连接。
      • vpn_gateway 企业版VPN网关。

    quota

    Integer

    配额上限。

    used

    Integer

    已使用数。

  • 响应样例
    {
        "quotas": {
            "resources": [
                {
                    "type": "customer_gateway",
                    "quota": 100,
                    "used": 13
                },
                {
                    "type": "vpn_connection",
                    "quota": 5000,
                    "used": 306
                },
                {
                    "type": "vpn_gateway",
                    "quota": 50,
                    "used": 23
                }
            ]
        },
        "request_id": "9aeb7f73-e1b6-42eb-96ad-b68aef8186e3"
    }

状态码

请参见状态码