Updated on 2024-04-19 GMT+08:00

Querying Quotas

Function

This API is used to query the used quotas of resources, such as enterprise routers and VPC attachments.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/enterprise-router/quotas

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page. Value range: 0 to 2000

Minimum: 0

Maximum: 2000

marker

No

String

ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit.

Minimum: 1

Maximum: 128

type

No

Array

You can query the quotas of the following resources:

  • er_instance: total and used quotas of enterprise routers

  • dc_attachment: total and used quotas of Direct Connect gateway attachments

  • vpc_attachment: total and used quotas of VPC attachments

  • vpn_attachment: total and used quotas of VPN gateways

  • peering_attachment: total and used quotas of peering connection attachments

  • can_attachment: total and used quotas of intelligent access gateway attachments

  • route_table: total and used quotas of route tables

  • static_route: total and used quotas of static routes

  • vpc_er: total and used quotas of enterprise routers that a VPC can be attached to

  • flow_log: total and used quotas of flow logs that can be created for each attachment

erId

No

Object

Enterprise router ID

routeTableId

No

Object

Route table ID

vpcId

No

Object

VPC ID

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

quotas

Array of Quota objects

Used quota details

Table 4 Quota

Parameter

Type

Description

quota_key

String

Quota type

quota_limit

Long

Available quota. The value -1 indicates that there is no quota limit.

used

Long

Used quota

unit

String

Measurement unit of used quotas

Example Requests

Querying the resource quotas

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/quotas

Example Responses

Status code: 200

OK

{
  "quotas" : [ {
    "quota_key" : "er_instance",
    "quota_limit" : 1,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "dc_attachment",
    "quota_limit" : 2,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "route_table",
    "quota_limit" : 20,
    "used" : 5,
    "unit" : "count"
  }, {
    "quota_key" : "static_route",
    "quota_limit" : 500,
    "used" : 2,
    "unit" : "count"
  }, {
    "quota_key" : "connect_attachment",
    "quota_limit" : 20,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "vpn_attachment",
    "quota_limit" : 10,
    "used" : 0,
    "unit" : "count"
  }, {
    "quota_key" : "flow_log",
    "quota_limit" : 20,
    "used" : 4,
    "unit" : "count"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.er.v3.region.ErRegion;
import com.huaweicloud.sdk.er.v3.*;
import com.huaweicloud.sdk.er.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ShowQuotasSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ErClient client = ErClient.newBuilder()
                .withCredential(auth)
                .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowQuotasRequest request = new ShowQuotasRequest();
        request.withType();
        request.withErId();
        request.withRouteTableId();
        request.withVpcId();
        try {
            ShowQuotasResponse response = client.showQuotas(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdker.v3.region.er_region import ErRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdker.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = ErClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ErRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowQuotasRequest()
        request.type = 
        request.er_id = 
        request.route_table_id = 
        request.vpc_id = 
        response = client.show_quotas(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := er.NewErClient(
        er.ErClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowQuotasRequest{}
	response, err := client.ShowQuotas(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.