查询全域公网带宽列表 - ListInternetBandwidths

功能介绍

查询全域公网带宽列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

eip:internetBandwidths:list

List

internetBandwidth *

-

-

-

-

g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
eip:internetBandwidths:list	List	internetBandwidth *	-	-	-
-	g:EnterpriseProjectId

URI

GET /v3/{domain_id}/geip/internet-bandwidths

表1 路径参数
参数	是否必选	参数类型	描述
domain_id	是	String	租户账号ID，获取租户账号ID请参见租户账号ID 最小长度：5 最大长度：32

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	每页条数最小值：0 最大值：2000
offset	否	Integer	分页查询起始的资源序号
marker	否	String	功能说明：上一页最后一条记录的ID 使用说明：必须与limit一起使用输入的值必须为有效的ID值
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
ext-fields	否	Array of strings	在默认显示字段的基础上追加指定字段
sort_key	否	Array of strings	按照sort_key指定的字段排序
sort_dir	否	Array of strings	功能说明：排序方向取值范围：asc（升序）、desc（降序）
id	否	Array of strings	根据ID过滤，支持多值查询，查询条件格式：id=xxx&id=xxx。
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	参数解释：根据全域公网带宽类型过滤。约束限制：不涉及取值范围： BioDir：出入云带宽。 Enter：企业型带宽。 Flx：Flexus带宽。 standard：标准带宽。 Ext：增程类型带宽。 Ext_Enter：增程企业型带宽。 Ext_BioDir：增程型出入云带宽。 IPv6：IPv6 Static Bandwidth。 Zixun：紫讯专属带宽。 STD：标准型带宽。 Lite：轻量型带宽。 Spec：客户专属带宽。默认取值：不涉及

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户的Token，获取用户Token请参见获取用户Token

响应参数

状态码：200

表4 响应Header参数
参数	参数类型	描述
X-Request-Id	String	本次请求编号

请求示例

查询全域公网带宽列表

GET https://{Endpoint}/v3/{domain_id}/geip/internet-bandwidths

响应示例

状态码：200

{
  "example" : {
    "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"
    }, {
      "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"
    } ],
    "page_info" : {
      "previous_marker" : "0a058187-dfb3-46e4-93da-6e7debfe0ff9",
      "current_count" : 2
    }
  },
  "schema" : {
    "$ref" : "#/components/schemas/ListInternetBandwidthsResponseBody"
  }
}