Help Center/ Elastic IP/ API Reference/ API V3/ Bandwidth/ Viewing Bandwidth Limits
Updated on 2026-11-06 GMT+08:00

Viewing Bandwidth Limits

Function

This API is used to obtain the EIP bandwidth limits. You can call this API to query data about a bandwidth, including its billing mode and upper and lower limits.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v3/{project_id}/eip/eip-bandwidth-limits

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

String

  • Definition: Number of resources returned on each page.

  • Range: 1 to 2000

marker

No

String

  • Definition: Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

Minimum: 0

Maximum: 36

page_reverse

No

Boolean

  • Definition: Pagination direction.

fields

No

String

  • Definition: Query field. Format: "fields=id&fields=bandwidth_type&..."

  • Supported fields: id, charge_mode, min_size, max_size, and ext_limit

Minimum: 0

Maximum: 1024

charge_mode

No

String

  • Definition: charge_mode is used as a filter.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

eip_bandwidth_limits

Array of ShowTenantDict objects

Bandwidth limits.

Array Length: 0 - 2000

page_info

PageInfoDict object

Pagination page number information.

request_id

String

Request ID.

Table 4 ShowTenantDict

Parameter

Type

Description

id

String

  • Definition: EIP ID, which uniquely identifies the EIP.

Minimum: 36

Maximum: 36

charge_mode

String

Bandwidth billing mode.

min_size

Integer

Minimum size of the bandwidth that can be purchased.

max_size

Integer

Maximum size of the bandwidth that can be purchased.

ext_limit

ExtLimitPojo object

Additional limits.

Table 5 ExtLimitPojo

Parameter

Type

Description

min_ingress_size

Integer

  • Minimum inbound bandwidth.

max_ingress_size

Integer

  • Maximum inbound bandwidth.

ratio_95peak

Integer

Minimum ratio of 95th percentile billing.

Table 6 PageInfoDict

Parameter

Type

Description

previous_marker

String

Marker value of the previous page.

next_marker

String

Marker value of the next page.

current_count

Integer

Total number of data records on the current page.

Example Requests

Query the bandwidth limits. You can filter the bandwidth limits based on the query field.

GET https://{Endpoint}/v3/{project_id}/eip/eip-bandwidth-limits

Example Responses

Status code: 200

{
  "request_id" : "4e5945ddd409f306b3cb4fd921a45390",
  "eip_bandwidth_limits" : [ {
    "id" : "08b4700e-cc3c-4aed-a35a-66022bcbd0f6",
    "charge_mode" : "bandwidth",
    "min_size" : 1,
    "max_size" : 500,
    "ext_limit" : null
  }, {
    "id" : "8a6990e6-638c-4a80-9da7-3c1a465ccf59",
    "charge_mode" : "traffic",
    "min_size" : 5,
    "max_size" : 2000,
    "ext_limit" : null
  } ],
  "page_info" : [ {
    "previous_marker" : "08b4700e-cc3c-4aed-a35a-66022bcbd0f6",
    "current_count" : 2
  } ]
}

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


public class ListBandwidthsLimitSolution {

    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);

        EipClient client = EipClient.newBuilder()
                .withCredential(auth)
                .withRegion(EipRegion.valueOf("<YOUR REGION>"))
                .build();
        ListBandwidthsLimitRequest request = new ListBandwidthsLimitRequest();
        try {
            ListBandwidthsLimitResponse response = client.listBandwidthsLimit(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkeip.v3.region.eip_region import EipRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkeip.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 = EipClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(EipRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListBandwidthsLimitRequest()
        response = client.list_bandwidths_limit(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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := eip.EipClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := eip.NewEipClient(hcClient)

    request := &model.ListBandwidthsLimitRequest{}
	response, err := client.ListBandwidthsLimit(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

Normal response to the GET operation

Error Codes

See Error Codes.