# 查询租户下的共享带宽类型列表 - ListShareBandwidthTypes #### 功能介绍 查询指定租户下的共享带宽类型列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ListShareBandwidthTypes&version=v3)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{project_id}/eip/share-bandwidth-types 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：项目ID。[请参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html) - 取值范围：不涉及 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | fields | 否 | String | - 功能说明：查询字段，形式为"fields=id\&fields=bandwidth_type\&..." - 支持字段：id/bandwidth_type/name_en/name_zh/created_at/updated_at/public_border_group/description 最小长度：**0** 最大长度：**1024** | | id | 否 | String | - 功能说明：支持带宽类型的ID 最小长度：**0** 最大长度：**36** | | bandwidth_type | 否 | String | - 参数解释：根据共享带宽类型过滤。 - 约束限制：不涉及 - 取值范围： - share：普通带宽。 - share_sbgp：静态BGP。 - edgeshare: 边缘带宽。 - share_bgp_enter：企业型通用共享带宽。 - share_sbgp_enter: 企业型静态共享带宽。 - share_bgp_flx：潮汐型通用共享带宽。 - share_cdn_inner: CDN互联专属带宽。 - share_sbgp_cph：云手机专属共享带宽。 - share_inner_spec_enter: 企业型专属云上带宽。 - share_op：专属弹性运营带宽。 - share_sbgp_ext：静态共享带宽增程型。 - share_bgp_ext：动态共享带宽增程型。 - share_dedi_vacant：闲时定向共享带宽。 - share_cph_static：云手机静态共享带宽。 - share_bjcm：北京移动共享带宽。 - share_bjcu：北京联通共享带宽。 - share_bjct：北京电信共享带宽。 - share_gzcm：广州移动共享带宽。 - share_gzcu：广州联通共享带宽。 - share_gzct：广州电信共享带宽。 - share_szcm：苏州移动共享带宽。 - share_shcu：上海联通共享带宽。 - share_shct：上海电信共享带宽。 - share_gycm：贵阳移动共享带宽。 - share_gycu：贵阳联通共享带宽。 - share_gyct：贵阳电信共享带宽。 - share_gyct_std：贵阳电信专属共享带宽。 - 默认取值：不涉及 最小长度：**1** 最大长度：**36** | | name_en | 否 | String | - 功能说明：带宽类型英文表述 最小长度：**0** 最大长度：**64** | | name_zh | 否 | String | - 功能说明：带宽类型中文表述 最小长度：**0** 最大长度：**64** | | public_border_group | 否 | String | - 功能说明：带宽类型所处位置，中心站点or边缘站点 最小长度：**0** 最大长度：**36** | | sort_key | 否 | String | - 功能说明：排序字段，形式为"sort_key=id\&sort_dir=asc" - 支持字段：id/bandwidth_type/public_border_group 最小长度：**0** 最大长度：**1024** | | sort_dir | 否 | String | - 功能说明：排序方向 - 取值范围： - asc 顺序 - desc 倒序 最小长度：**0** 最大长度：**1024** | | limit | 否 | Integer | - 功能说明：每页返回的资源个数 - 取值范围：1\~2000 最小值：**0** 最大值：**2000** | | offset | 否 | Integer | 功能说明：分页查询起始的资源序号 | | marker | 否 | String | 功能说明：分页查询起始的资源ID（不含），为空时查询第一页 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | share_bandwidth_types | Array of [ShareBandwidthTypeShowResp] objects | 共享带宽类型对象 数组长度：**0 - 9999** | | request_id | String | 本次请求的编号 | | page_info | [PageInfoOption] object | 分页页码信息 | 表4ShareBandwidthTypeShowResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 支持带宽类型的id 最小长度：**0** 最大长度：**36** | | bandwidth_type | String | - 参数解释：根据共享带宽类型过滤。 - 约束限制：不涉及 - 取值范围： - share：普通带宽。 - share_sbgp：静态BGP。 - edgeshare: 边缘带宽。 - share_bgp_enter：企业型通用共享带宽。 - share_sbgp_enter: 企业型静态共享带宽。 - share_bgp_flx：潮汐型通用共享带宽。 - share_cdn_inner: CDN互联专属带宽。 - share_sbgp_cph：云手机专属共享带宽。 - share_inner_spec_enter: 企业型专属云上带宽。 - share_op：专属弹性运营带宽。 - share_sbgp_ext：静态共享带宽增程型。 - share_bgp_ext：动态共享带宽增程型。 - share_dedi_vacant：闲时定向共享带宽。 - share_cph_static：云手机静态共享带宽。 - share_bjcm：北京移动共享带宽。 - share_bjcu：北京联通共享带宽。 - share_bjct：北京电信共享带宽。 - share_gzcm：广州移动共享带宽。 - share_gzcu：广州联通共享带宽。 - share_gzct：广州电信共享带宽。 - share_szcm：苏州移动共享带宽。 - share_shcu：上海联通共享带宽。 - share_shct：上海电信共享带宽。 - share_gycm：贵阳移动共享带宽。 - share_gycu：贵阳联通共享带宽。 - share_gyct：贵阳电信共享带宽。 - share_gyct_std：贵阳电信专属共享带宽。 - 默认取值：不涉及 最小长度：**0** 最大长度：**36** | | public_border_group | String | 中心站点or边缘站点，默认展示 最小长度：**0** 最大长度：**64** | | created_at | String | 创建时间 最小长度：**0** 最大长度：**64** | | updated_at | String | 更新时间 最小长度：**0** 最大长度：**64** | | name_en | String | 带宽类型的英文表述 最小长度：**0** 最大长度：**256** | | name_zh | String | 带宽类型的中文表述 最小长度：**0** 最大长度：**256** | | description | String | 带宽类型描述信息 最小长度：**0** 最大长度：**1024** | 表5PageInfoOption | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释：** 翻页时，作为前一页的marker取值。 **取值范围：** 不涉及。 | | next_marker | String | **参数解释：** 翻页时，作为后一页的marker取值。 **取值范围：** 不涉及。 | | current_count | Integer | **参数解释：** 当前页的数据总数。 **取值范围：** 0-99999 | #### 请求示例 查询租户支持的共享带宽类型列表 ``` GET https://{Endpoint}/v3/{project_id}/eip/share-bandwidth-types ``` #### 响应示例 **状态码：200** ``` { "share_bandwidth_types" : [ { "id" : "1b478471-eaf1-4a71-9c77-edba89f62016", "bandwidth_type" : "share", "name_en" : "share_bandwidth_type", "name_zh" : "中心带宽类型", "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" : "边缘带宽类型", "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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] ``` # 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("")) \ .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] ``` 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("")). 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=ListShareBandwidthTypes&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。