Viewing Bandwidth Limits
Function
This API is used to obtain the EIP bandwidth limits.
URI
GET /v3/{project_id}/eip/eip-bandwidth-limits
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
project_id |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Minimum value: 0 Maximum value: 2000 |
offset |
No |
Integer |
Start page number |
marker |
No |
String |
Start page number |
page_reverse |
No |
Boolean |
Direction of page turning |
fields |
No |
Array |
Display only the specified fields. If ext-fields is used, fields are added in addition to the default ones. The value can be:
|
charge_mode |
No |
String |
Filter by billing mode. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
eip_bandwidth_limits |
Array of ShowTenantDict objects |
Bandwidth limits Array length: 0 to 2000 |
page_info |
PageInfoDict object |
Pagination page number information. |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Minimum length: 36 Maximum length: 36 |
charge_mode |
String |
Bandwidth billing mode The value can be:
|
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 |
Example Request
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 Response
Status code: 200
Normal response to the GET operation
{ "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 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 48 49 50 51 52 53 |
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.*; import java.util.List; import java.util.ArrayList; 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); ListBandwidthsLimitRequest request = new ListBandwidthsLimitRequest(); request.withLimit(<limit>); request.withOffset(<offset>); request.withMarker("<marker>"); request.withPageReverse(<page_reverse>); request.withFields(); request.withChargeMode("<charge_mode>"); 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()); } } } |
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListBandwidthsLimitRequest() request.limit = <limit> request.offset = <offset> request.marker = "<marker>" request.page_reverse = <PageReverse> request.fields = request.charge_mode = "<charge_mode>" 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) |
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := eip.NewEipClient( eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListBandwidthsLimitRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest markerRequest:= "<marker>" request.Marker = &markerRequest pageReverseRequest:= <page_reverse> request.PageReverse = &pageReverseRequest chargeModeRequest:= "<charge_mode>" request.ChargeMode = &chargeModeRequest response, err := client.ListBandwidthsLimit(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response to the GET operation |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot