Querying Quotas

Function

This API is used to query the quotas of load balancers and related resources in a specific project. The API returns only the total quota, not the used quota. To query the used quota, you can call the API (GET /v3/{project_id}/elb/quotas/details) to query quota usage details.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/elb/quotas

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).
quota	Quota object	Definition: Specifies the quotas of load balancers and associated resources. Only the total quotas are returned. Remaining available quotas will not be returned.

**Table 4** Quota
Parameter	Type	Description
project_id	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.
loadbalancer	Integer	Definition: Specifies the load balancer quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
certificate	Integer	Definition: Specifies the certificate quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
listener	Integer	Definition: Specifies the listener quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
l7policy	Integer	Definition: Specifies the forwarding policy quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
condition_per_policy	Integer	Definition: Specifies the maximum number of forwarding conditions per forwarding policy. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
pool	Integer	Definition: Specifies the backend server group quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
healthmonitor	Integer	Definition: Specifies the health check quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
member	Integer	Definition: Specifies the backend server quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
members_per_pool	Integer	Definition: Specifies the maximum number of backend servers in a backend server group. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
listeners_per_pool	Integer	Definition: Specifies the maximum number of listeners that can be associated with a backend server group. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
ipgroup	Integer	Definition: Specifies the IP address group quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
ipgroup_bindings	Integer	Definition: Specifies the maximum number of listeners that can be associated with an IP address group. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
ipgroup_max_length	Integer	Definition: Specifies the maximum number of IP entries that can be added to an IP address group. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
security_policy	Integer	Definition: Specifies the custom security policy quota. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
listeners_per_loadbalancer	Integer	Definition: Specifies the maximum number of listeners that can be associated with a load balancer. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited. NOTE: The maximum number of listeners that can be added to each load balancer is not limited, but it is recommended that the listeners not exceed the default quota.
ipgroups_per_listener	Integer	Definition: Specifies the maximum number of IP address groups that can be associated with a listener. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
pools_per_l7policy	Integer	Definition: Specifies the maximum number of backend server groups that can be associated with a forwarding policy. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
l7policies_per_listener	Integer	Definition: Specifies the maximum number of forwarding policies that can be associated with a listener. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
free_instance_members_per_pool	Integer	Definition: Specifies the maximum number of backend servers that can be added to a backend server group for free. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.
free_instance_listeners_per_loadbalancer	Integer	Definition: Specifies the maximum number of listeners that can be associated with a load balancer for free. Range: If the value is greater than or equal to 0, it indicates the current quota. -1 indicates that the quota is not limited.

Example Requests

Querying the quotas of resources associated with a load balancer

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/quotas

Example Responses

Status code: 200

Successful request.

{
  "request_id" : "c6f3d7fe99bb1d8aa29e148097dab0d0",
  "quota" : {
    "member" : 10000,
    "members_per_pool" : 1000,
    "certificate" : -1,
    "l7policy" : 2000,
    "listener" : 1500,
    "loadbalancer" : 100000,
    "healthmonitor" : -1,
    "pool" : 5000,
    "ipgroup" : 1000,
    "ipgroup_bindings" : 50,
    "ipgroup_max_length" : 300,
    "security_policy" : 50,
    "project_id" : "060576798a80d5762fafc01a9b5eedc7",
    "condition_per_policy" : 10,
    "listeners_per_pool" : 50,
    "listeners_per_loadbalancer" : 50,
    "free_instance_members_per_pool" : 50,
    "free_instance_listeners_per_loadbalancer" : 10
  }
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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 ShowQuotaSolution {

    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();
        ShowQuotaRequest request = new ShowQuotaRequest();
        try {
            ShowQuotaResponse response = client.showQuota(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ShowQuotaRequest()
        response = client.show_quota(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.ShowQuotaRequest{}
	response, err := client.ShowQuota(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     