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

Querying Quotas

Function

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

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

Specifies the project ID.

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Note: The value is automatically generated.

quota

Quota object

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

Specifies the project ID.

loadbalancer

Integer

Specifies the load balancer quota.

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

  • If the value is -1, the quota is not limited.

certificate

Integer

Specifies the certificate quota.

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

  • If the value is -1, the quota is not limited.

listener

Integer

Specifies the listener quota.

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

  • If the value is -1, the quota is not limited.

l7policy

Integer

Specifies the forwarding policy quota.

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

  • If the value is -1, the quota is not limited.

condition_per_policy

Integer

Specifies the maximum number of forwarding rules per forwarding policy.

  • 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

Specifies the backend server group quota.

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

  • If the value is -1, the quota is not limited.

healthmonitor

Integer

Specifies the health check quota.

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

  • If the value is -1, the quota is not limited.

member

Integer

Specifies the backend server quota.

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

  • If the value is -1, the quota is not limited.

members_per_pool

Integer

Specifies the maximum number of backend servers in a backend server group.

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

  • If the value is -1, the quota is not limited.

listeners_per_pool

Integer

Specifies the maximum number of backend server groups that can be associated with a listener.

  • 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

Specifies the IP address group quota.

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

  • If the value is -1, the quota is not limited.

ipgroup_bindings

Integer

Specifies the maximum number of listeners that can be associated with an IP address group.

  • If the value is greater than or equal to 0, it indicates the maximum number of listeners that can be associated with an IP address group.

  • If the value is -1, the quota is not limited.

ipgroup_max_length

Integer

Specifies the maximum number of IP addresses that can be added to an IP address group.

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

  • If the value is -1, the quota is not limited.

security_policy

Integer

Specifies the custom security policy quota.

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

  • If the value is -1, the quota is not limited.

listeners_per_loadbalancer

Integer

Specifies the maximum number of listeners that can be associated with a load balancer.

The value can be:

  • 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 the listeners not exceed the default quota.

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
  }
}

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 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());
        }
    }
}
 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 = 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)
 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.ShowQuotaRequest{}
	response, err := client.ShowQuota(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.