Updated on 2024-09-26 GMT+08:00

Querying Quota Usage

Function

This API is used to query the current quotas and used quotas of resources related to a dedicated load balancer in a specific project.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/elb/quotas/details

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

quota_key

No

Array of strings

Specifies the resource type. The value can be loadbalancer, listener, ipgroup, pool, member, healthmonitor, l7policy, certificate, security_policy, listeners_per_loadbalancer, listeners_per_pool, members_per_pool, condition_per_policy, ipgroup_bindings, or ipgroup_max_length.

Multiple values can be queried in the format of quota_key=xxx&quota_key=xxx.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the token used for IAM authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Note: The value is automatically generated.

quotas

Array of QuotaInfo objects

Specifies the resource quotas.

Table 5 QuotaInfo

Parameter

Type

Description

quota_key

String

Specifies the resource type. The value can be loadbalancer, listener, ipgroup, pool, member, healthmonitor, l7policy, certificate, security_policy, listeners_per_loadbalancer, listeners_per_pool, members_per_pool, condition_per_policy, ipgroup_bindings, or ipgroup_max_length.

quota_limit

Integer

Specifies the total quota.

Values:

  • If the value is greater than or equal to 0, it indicates the current quota.

  • -1 indicates that the quota is not limited.

used

Integer

Specifies the used quota.

unit

String

Specifies the quota unit.

The value can only be count.

Example Requests

Querying the quota of a specific ELB resource type

https://{ELB_Endpoint}/v3/06b9dc6cbf80d5952f18c0181a2f4654/elb/quotas/details?quota_key=members_per_pool&quota_key=loadbalancer

Example Responses

Status code: 200

Successful request.

{
  "request_id" : "a396ad8e282d69d1afec6d437fe93c2d",
  "quotas" : [ {
    "quota_key" : "members_per_pool",
    "used" : 992,
    "quota_limit" : 1000,
    "unit" : "count"
  }, {
    "quota_key" : "security_policy",
    "used" : 11,
    "quota_limit" : 50,
    "unit" : "count"
  }, {
    "quota_key" : "ipgroup_max_length",
    "used" : 3,
    "quota_limit" : 300,
    "unit" : "count"
  }, {
    "quota_key" : "listener",
    "used" : 803,
    "quota_limit" : 1500,
    "unit" : "count"
  }, {
    "quota_key" : "pool",
    "used" : 1009,
    "quota_limit" : 5000,
    "unit" : "count"
  }, {
    "quota_key" : "certificate",
    "used" : 608,
    "quota_limit" : -1,
    "unit" : "count"
  }, {
    "quota_key" : "loadbalancer",
    "used" : 752,
    "quota_limit" : 100000,
    "unit" : "count"
  }, {
    "quota_key" : "ipgroup",
    "used" : 11,
    "quota_limit" : 1000,
    "unit" : "count"
  }, {
    "quota_key" : "ipgroup_bindings",
    "used" : 2,
    "quota_limit" : 50,
    "unit" : "count"
  }, {
    "quota_key" : "member",
    "used" : 3022,
    "quota_limit" : 10000,
    "unit" : "count"
  }, {
    "quota_key" : "listeners_per_loadbalancer",
    "used" : 0,
    "quota_limit" : 50,
    "unit" : "count"
  }, {
    "quota_key" : "l7policy",
    "used" : 148,
    "quota_limit" : 2000,
    "unit" : "count"
  }, {
    "quota_key" : "healthmonitor",
    "used" : 762,
    "quota_limit" : -1,
    "unit" : "count"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 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
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.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class ListQuotaDetailsSolution {

    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");
        String projectId = "{project_id}";

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

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        ListQuotaDetailsRequest request = new ListQuotaDetailsRequest();
        try {
            ListQuotaDetailsResponse response = client.listQuotaDetails(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ListQuotaDetailsRequest()
        response = client.list_quota_details(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/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")
    projectId := "{project_id}"

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

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

Successful request.

Error Codes

See Error Codes.