# 查询全域公网带宽列表 - ListInternetBandwidths #### 功能介绍 查询全域公网带宽列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GEIP/doc?api=ListInternetBandwidths)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:internetBandwidths:list | List | internetBandwidth \* | - | - | - | | eip:internetBandwidths:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{domain_id}/geip/internet-bandwidths 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释：** 租户账号ID，获取租户账号ID请参见[租户账号ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 最小长度：**5** 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 每页条数。 **约束限制：** 不涉及。 **取值范围：** 0-2000 **默认取值：** 不涉及。 最小值：**0** 最大值：**2000** | | offset | 否 | Integer | **参数解释：** 分页查询起始的资源序号。 **约束限制：** 不涉及。 **取值范围：** 0-2000 **默认取值：** 不涉及。 | | marker | 否 | String | **参数解释：** 上一页最后一条记录的ID。 **约束限制：** - 必须与limit一起使用。 - 输入的值必须为有效的ID值。 **取值范围：** 格式：\[a-fA-F0-9\]{8}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{12} **默认取值：** 不涉及。 | | page_reverse | 否 | Boolean | **参数解释：** 翻页方向。 **约束限制：** 不涉及。 **取值范围：** - true：查询上一页。 - false：查询下一页。 **默认取值：** 不涉及。 | | fields | 否 | Array of strings | **参数解释：** 查询指定的字段。 **约束限制：** 格式为fields=A\&fields=B\&fields=C\&...... **取值范围：** 支持的字段： - id - name - isp - ingress_size - access_site - size - description - charge_mode - ratio_95peak - freezen_info - domain_id - status - created_at - updated_at - is_pre_paid - is_change_service - type - tags - sys_tags - enterprise_project_id - tos_infos **默认取值：** 不涉及。 | | ext-fields | 否 | Array of strings | **参数解释：** 在默认显示字段的基础上追加指定字段。 **约束限制：** 不涉及。 **取值范围：** - geip_count - geip_segment_count **默认取值：** 不涉及。 | | sort_key | 否 | Array of strings | **参数解释：** 按照sort_key指定的字段排序。 **约束限制：** 不涉及。 **取值范围：** - id - size - created_at - updated_at **默认取值：** 不涉及。 | | sort_dir | 否 | Array of strings | **参数解释：** 排序方向。 **约束限制：** 不涉及。 **取值范围：** - asc：升序 - desc：降序 **默认取值：** 不涉及。 | | id | 否 | Array of strings | **参数解释：** 根据ID过滤，支持多值查询。 **约束限制：** 查询条件格式：id=xxx\&id=xxx。 **取值范围：** 格式：\[a-fA-F0-9\]{8}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{4}-\[a-fA-F0-9\]{12} **默认取值：** 不涉及。 | | size | 否 | Array of integers | **参数解释：** 根据全域公网带宽大小过滤。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name | 否 | Array of strings | **参数解释：** 根据名称过滤，支持多值查询。 **约束限制：** 查询条件格式：name=xxx\&name=xxx。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name_like | 否 | String | **参数解释：** 根据名称模糊匹配。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | access_site | 否 | Array of strings | **参数解释：** 根据接入点过滤，支持多值查询。 **约束限制：** 查询条件格式：access_site=xxx\&access_site=xxx。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | status | 否 | Array of strings | **参数解释：** 根据资源状态过滤。 **约束限制：** 不涉及。 **取值范围：** - freezed：冻结状态 - normal：正常状态 **默认取值：** 不涉及。 | | enterprise_project_id | 否 | Array of strings | **参数解释：** 根据企业项目ID过滤。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | tags | 否 | Array of strings | **参数解释：** 根据标签过滤。 **约束限制：** 过滤格式为key1\|value1,key2\|value2,... **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | type | 否 | Array of strings | **参数解释：** 根据全域公网带宽类型过滤。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户的Token，如何获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html#iam_30_0001__li195948474711)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 本次请求编号 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释：** 请求ID。 **取值范围：** 不涉及。 | | internet_bandwidths | Array of [ListInternetBandwidths] objects | **参数解释：** 全域公网带宽列表。 **取值范围：** 不涉及。 | | page_info | [page_info] object | **参数解释：** 分页页码信息。 **取值范围：** 不涉及。 | 表6ListInternetBandwidths | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 全域公网带宽的ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 全域公网带宽名称。 **取值范围：** 1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 最小长度：**1** 最大长度：**64** | | isp | String | **参数解释：** 全域公网带宽接入的线路，接入线路信息可通过[查询全域弹性公网IP池列表](https://support.huaweicloud.com/api-eip/ListGeipPools.html)接口查询。 **取值范围：** 不涉及。 | | ingress_size | Integer | **参数解释：** 全域公网带宽大小（入云方向）。 **取值范围：** 不涉及。 | | access_site | String | **参数解释：** 接入点信息，具体接入点信息可通过[查询接入点列表](https://support.huaweicloud.com/api-eip/ListAccessSites.html)接口查询。 **取值范围：** 不涉及。 | | size | Integer | **参数解释：** 全域公网带宽大小（出云方向）。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 用户自定义的资源描述。 **取值范围：** 值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。 最小长度：**0** 最大长度：**512** | | charge_mode | String | **参数解释：** 计费模式，客户支持的计费类型可通过[全域公网带宽限制列表](https://support.huaweicloud.com/api-eip/ListInternetBandwidthLimits.html)接口查询。 其中95计费需要满足一定条件才可使用，具体请见[计费类](https://support.huaweicloud.com/eip_faq/faq_price_0017.html)。 **取值范围：** - bandwidth：按带宽计费 - traffic：按流量计费 - 95peak_plus_1000：按增强型95计费 - 95peak_bidirection：按双向型传统95计费 - 95peak_guar：带保底传统型95计费 - 95peak_avr：95峰值平均计费 | | ratio_95peak | Integer | **参数解释：** 增强95保底率。 **取值范围：** 不涉及。 | | billing_info | String | **参数解释：** 订单信息。 **取值范围：** 不涉及。 | | freezen_info | String | **参数解释：** 冻结原因。 **取值范围：** 不涉及。 | | domain_id | String | **参数解释：** 租户账号ID，获取租户账号ID请参见[租户账号ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 状态。 **取值范围：** - NORMAL：正常状态 - FREEZED：冻结状态 | | created_at | String | **参数解释：** 创建时间。 **取值范围：** 格式: yyyy-MM-dd'T'HH:mm:ss'Z' | | updated_at | String | **参数解释：** 更新时间。 **取值范围：** 格式: yyyy-MM-dd'T'HH:mm:ss'Z' | | is_pre_paid | Boolean | **参数解释：** 是否包周期。 **取值范围：** 不涉及。 | | is_change_service | Boolean | **参数解释：** 是否切换服务到VPC。 **取值范围：** 不涉及。 | | tags | Array of [Tag] objects | **参数解释：** 全域公网带宽标签。 **取值范围：** 不涉及。 | | enterprise_project_id | String | **参数解释：** 企业项目ID。创建全域公网带宽时，给全域公网带宽绑定企业项目ID。关于企业项目ID的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 **取值范围：** - 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。 - 不指定该参数时，默认值是 0。 | | type | String | **参数解释：** 全域公网带宽类型。 **取值范围：** 不涉及。 | | tos_infos | Array of [tos] objects | **参数解释：** 全域公网带宽服务分类信息。 **取值范围：** 不涉及。 | 表7Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签名称。同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。单个资源最多可以添加20个标签。 **取值范围：** 键的长度最大128字符，由英文字母、数字、下划线、中划线、中文字符组成。 最小长度：**1** 最大长度：**128** | | value | String | **参数解释：** 标签值。 **取值范围：** 值的长度最大255字符，由英文字母、数字、下划线、点、中划线、中文字符组成。 最小长度：**0** 最大长度：**255** | 表8tos | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 服务类型标识 | | code | Integer | 服务类型编码 | 表9page_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释：** 翻页时，作为后一页的marker取值。 **取值范围：** 不涉及。 | | previous_marker | String | **参数解释：** 翻页时，作为前一页的marker取值。 **取值范围：** 不涉及。 | | current_count | Integer | **参数解释：** 当前页的数据总数。 **取值范围：** 不涉及。 | #### 请求示例 查询全域公网带宽列表 ``` GET https://{Endpoint}/v3/{domain_id}/geip/internet-bandwidths ``` #### 响应示例 **状态码：200** ``` { "request_id" : "d224afc0e7add65c715707dbadd3004a", "internet_bandwidths" : [ { "enterprise_project_id" : 0, "name" : "bandwidth-8dd3", "created_at" : "2023-06-29T08:25:12Z", "updated_at" : "2023-06-29T08:25:12Z", "id" : "0a058187-dfb3-46e4-93da-6e7debfe0ff9", "isp" : "BGP", "access_site" : "cn-south-odin", "size" : 1, "description" : null, "charge_mode" : "bandwidth", "freezen_info" : null, "domain_id" : "f35feb8670a94a04a08d6628e0d5165b", "is_pre_paid" : false, "is_change_service" : false, "status" : "normal", "ratio_95peak" : 0, "ingress_size" : 10, "tags" : [ ], "type" : "standard", "tos_infos" : [ ] }, { "enterprise_project_id" : 0, "name" : "bandwidth-b5be", "created_at" : "2023-06-09T06:54:35Z", "updated_at" : "2023-06-09T06:54:35Z", "id" : "0c5dcd3e-8871-44c3-8619-31a6aa162f7f", "isp" : "BGP", "access_site" : "cn-south-odin", "size" : 5, "description" : null, "charge_mode" : "bandwidth", "freezen_info" : null, "domain_id" : "f35feb8670a94a04a08d6628e0d5165b", "is_pre_paid" : false, "is_change_service" : true, "status" : "normal", "ratio_95peak" : 0, "ingress_size" : 10, "tags" : [ ], "type" : "standard", "tos_infos" : [ ] } ], "page_info" : { "previous_marker" : "0a058187-dfb3-46e4-93da-6e7debfe0ff9", "current_count" : 2 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。