文档首页/ 弹性公网IP EIP/ API参考/ GEIP API/ 全域公网带宽/ 查询全域公网带宽列表
更新时间：2024-04-26 GMT+08:00
查看PDF
分享

查询全域公网带宽列表

功能介绍

查询全域公网带宽列表

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

最小长度：5

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页条数

最小值：0

最大值：2000

offset

否

Integer

分页查询起始的资源序号

marker

否

String

分页起始点

page_reverse

否

Boolean

翻页方向

fields

否

Array

只显示指定的字段

ext-fields

否

Array

在默认显示字段的基础上追加指定字段

sort_key

否

Array

按照sort_key指定的字段排序

sort_dir

否

Array

  • 功能说明：排序方向

  • 取值范围：asc（升序）、desc（降序）

id

否

Array

根据ID过滤

size

否

Array

根据全域公网带宽大小过滤

name

否

Array

根据名称过滤

name_like

否

String

根据名称模糊匹配

access_site

否

Array

根据接入点过滤

status

否

Array

根据资源状态过滤

enterprise_project_id

否

Array

根据企业项目ID过滤

tags

否

Array

根据标签过滤，过滤格式为key1|value1,key2|value2,...

type

否

Array

根据全域公网带宽类型过滤

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户的Token，如何获取用户Token请参见获取用户Token

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

-

本次请求编号
表5 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

internet_bandwidths

Array of ListInternetBandwidths objects

全域公网带宽列表

page_info

page_info object

分页页码信息
表6 ListInternetBandwidths

参数

参数类型

描述

id

String

全域公网带宽的ID

name

String

  • 功能说明：全域公网带宽名称

  • 取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最小长度：1

最大长度：64

isp

String

接入线路

ingress_size

Integer

全域公网带宽大小（入云方向）

access_site

String

接入点信息

size

Integer

全域公网带宽大小（出云方向）

description

String

  • 功能说明：用户自定义的资源描述

  • 约束：

    • 值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。

最小长度：0

最大长度：512

charge_mode

String

  • 功能说明：计费模式，按带宽还是按流量计费

  • 取值范围：bandwidth（按带宽计费），traffic（按流量计费）

最小长度：1

最大长度：36

ratio_95peak

Integer

增强95保底率

billing_info

String

订单信息

freezen_info

String

冻结原因

domain_id

String

status

String

状态

枚举值：

  • NORMAL

  • FREEZED

created_at

String

创建时间

updated_at

String

更新时间

is_pre_paid

Boolean

是否包周期

tags

Array of Tag objects

全域公网带宽标签

enterprise_project_id

String

  • 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 创建全域公网带宽时，给全域公网带宽绑定企业项目ID。

  • 不指定该参数时，默认值是 0

  • 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

type

String

全域公网带宽类型
表7 Tag

参数

参数类型

描述

key

String

  • 功能说明：标签名称

  • 约束：

    • 同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。

    • 键的长度最大36字符，由英文字母、数字、下划线、中划线、中文字符组成。

    • 单个资源最多可以添加20个标签。

最小长度：1

最大长度：36

value

String

  • 功能说明：标签值

  • 约束：

    • 值的长度最大43字符，由英文字母、数字、下划线、点、中划线、中文字符组成。

最小长度：0

最大长度：43
表8 page_info

参数

参数类型

描述

next_marker

String

翻页时，作为后一页的marker取值

previous_marker

String

翻页时，作为前一页的marker取值

current_count

Integer

当前页的数据总数

请求示例

查询全域公网带宽列表

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

响应示例

状态码： 200

OK

{
  "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,
    "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,
    "status" : "normal",
    "ratio_95peak" : 0,
    "ingress_size" : 10,
    "tags" : [ ],
    "type" : "standard"
  } ],
  "page_info" : {
    "previous_marker" : "0a058187-dfb3-46e4-93da-6e7debfe0ff9",
    "current_count" : 2
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 全域公网带宽

相关文档