Help Center/ Elastic IP/ API Reference/ API V3/ Shared Bandwidth Type/ Querying Shared Bandwidth Types of a Tenant
Updated on 2026-11-06 GMT+08:00

Querying Shared Bandwidth Types of a Tenant

Function

This API is used to query shared bandwidth types of a specified tenant.

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/share-bandwidth-types

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fields

No

String

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

  • Supported fields: id, bandwidth_type, name_en, name_zh, created_at, updated_at, public_border_group, and description

Minimum: 0

Maximum: 1024

id

No

String

  • Definition: Bandwidth type ID.

Minimum: 0

Maximum: 36

bandwidth_type

No

String

  • Definition: The shared bandwidth type is used as a filter.

  • Constraints: N/A

  • Range:

    • share: common bandwidth

    • share_sbgp: static BGP

    • edgeshare: edge bandwidth

    • share_bgp_enter: enterprise-level general shared bandwidth

    • share_sbgp_enter: enterprise-level static shared bandwidth

    • share_bgp_flx: general shared bandwidth for tidal services

    • share_cdn_inner: bandwidth dedicated for CDN interconnection

    • share_sbgp_cph: shared bandwidth dedicated for Cloud Phone

    • share_inner_spec_enter: bandwidth dedicated for enterprises

    • share_op: bandwidth dedicated for elastic operations

    • share_sbgp_ext: extended static shared bandwidth

    • share_bgp_ext: extended dynamic shared bandwidth

    • share_dedi_vacant: shared bandwidth for off-peak hours

    • share_cph_static: static shared bandwidth for Cloud Phone

    • share_bjcm: shared bandwidth for China Mobile Beijing

    • share_bjcu: shared bandwidth for China Unicom Beijing

    • share_bjct: shared bandwidth for China Telecom Beijing

    • share_gzcm: shared bandwidth for China Mobile Guangzhou

    • share_gzcu: shared bandwidth for China Unicom Guangzhou

    • share_gzct: shared bandwidth for China Telecom Guangzhou

    • share_szcm: shared bandwidth for China Mobile Suzhou

    • share_shcu: shared bandwidth for China Unicom Shanghai

    • share_shct: shared bandwidth for China Telecom Shanghai

    • share_gycm: shared bandwidth for China Mobile Guiyang

    • share_gycu: shared bandwidth for China Unicom Guiyang

    • share_gyct: shared bandwidth for China Telecom Guiyang

    • share_gyct_std: shared bandwidth dedicated for China Telecom Guiyang

  • Default Value: N/A

Minimum: 1

Maximum: 36

name_en

No

String

  • Definition: Bandwidth type in English.

Minimum: 0

Maximum: 64

name_zh

No

String

  • Definition: Bandwidth type in Chinese.

Minimum: 0

Maximum: 64

public_border_group

No

String

  • Definition: Whether the bandwidth type is in a central region or an edge site.

Minimum: 0

Maximum: 36

sort_key

No

String

  • Definition: Sorting key. Format: "sort_key=id&sort_dir=asc"

  • Supported fields: id, bandwidth_type, and public_border_group

Minimum: 0

Maximum: 1024

sort_dir

No

String

  • Definition: Sorting direction.

  • Range:

    • asc: ascending order

    • desc: descending order

Minimum: 0

Maximum: 1024

limit

No

Integer

  • Definition: Number of resources returned on each page.

  • Range: 1 to 2000

Minimum: 0

Maximum: 2000

offset

No

Integer

Definition: Start resource number of pagination query.

marker

No

String

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

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

share_bandwidth_types

Array of ShareBandwidthTypeShowResp objects

Shared bandwidth type.

Array Length: 0 - 9999

request_id

String

Request ID.

page_info

PageInfoOption object

Pagination page number information.

Table 4 ShareBandwidthTypeShowResp

Parameter

Type

Description

id

String

ID of the supported bandwidth type.

Minimum: 0

Maximum: 36

bandwidth_type

String

  • Definition: Shared bandwidth type is used as a filter.

  • Constraints: N/A

  • Range:

    • share: common bandwidth

    • share_sbgp: static BGP

    • edgeshare: edge bandwidth

    • share_bgp_enter: enterprise-level general shared bandwidth

    • share_sbgp_enter: enterprise-level static shared bandwidth

    • share_bgp_flx: general shared bandwidth for tidal services

    • share_cdn_inner: bandwidth dedicated for CDN interconnection

    • share_sbgp_cph: shared bandwidth dedicated for Cloud Phone

    • share_inner_spec_enter: bandwidth dedicated for enterprises

    • share_op: bandwidth dedicated for elastic operations

    • share_sbgp_ext: extended static shared bandwidth

    • share_bgp_ext: extended dynamic shared bandwidth

    • share_dedi_vacant: shared bandwidth for off-peak hours

    • share_cph_static: static shared bandwidth for Cloud Phone

    • share_bjcm: shared bandwidth for China Mobile Beijing

    • share_bjcu: shared bandwidth for China Unicom Beijing

    • share_bjct: shared bandwidth for China Telecom Beijing

    • share_gzcm: shared bandwidth for China Mobile Guangzhou

    • share_gzcu: shared bandwidth for China Unicom Guangzhou

    • share_gzct: shared bandwidth for China Telecom Guangzhou

    • share_szcm: shared bandwidth for China Mobile Suzhou

    • share_shcu: shared bandwidth for China Unicom Shanghai

    • share_shct: shared bandwidth for China Telecom Shanghai

    • share_gycm: shared bandwidth for China Mobile Guiyang

    • share_gycu: shared bandwidth for China Unicom Guiyang

    • share_gyct: shared bandwidth for China Telecom Guiyang

    • share_gyct_std: shared bandwidth dedicated for China Telecom Guiyang

  • Default Value: N/A

Minimum: 0

Maximum: 36

public_border_group

String

Central region or edge site. The parameter is displayed by default.

Minimum: 0

Maximum: 64

created_at

String

Creation time

Minimum: 0

Maximum: 64

updated_at

String

Update time

Minimum: 0

Maximum: 64

name_en

String

Bandwidth type in English.

Minimum: 0

Maximum: 256

name_zh

String

Bandwidth type in Chinese.

Minimum: 0

Maximum: 256

description

String

Bandwidth type description.

Minimum: 0

Maximum: 1024

Table 5 PageInfoOption

Parameter

Type

Description

previous_marker

String

Definition

Marker value of the previous page.

Range

N/A

next_marker

String

Definition

Marker value of the next page.

Range

N/A

current_count

Integer

Definition

Total number of data records on the current page.

Range

0 to 99999

Example Requests

Query shared bandwidth types of a specified tenant.

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

Example Responses

Status code: 200

{
  "share_bandwidth_types" : [ {
    "id" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "bandwidth_type" : "share",
    "name_en" : "share_bandwidth_type",
    "name_zh" : "Central bandwidth type.",
    "description" : null,
    "created_at" : "2021-09-29T04:19:22Z",
    "updated_at" : "2021-09-29T04:19:22Z",
    "public_border_group" : "center"
  }, {
    "id" : "2bbb2990-e908-46a7-b664-03d3084af032",
    "bandwidth_type" : "edgeshare",
    "name_en" : "edge_share_bandwidth_type",
    "name_zh" : "Edge bandwidth type.",
    "description" : null,
    "created_at" : "2021-09-29T04:19:22Z",
    "updated_at" : "2021-09-29T04:19:22Z",
    "public_border_group" : "az1"
  } ],
  "request_id" : "07f05e3d-b688-43f8-bda2-e9d10d2352e9",
  "page_info" : {
    "previous_marker" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "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 ListShareBandwidthTypesSolution {

    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();
        ListShareBandwidthTypesRequest request = new ListShareBandwidthTypesRequest();
        try {
            ListShareBandwidthTypesResponse response = client.listShareBandwidthTypes(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 = ListShareBandwidthTypesRequest()
        response = client.list_share_bandwidth_types(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.ListShareBandwidthTypesRequest{}
	response, err := client.ListShareBandwidthTypes(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.