文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 共享带宽类型/ 查询指定租户下的共享带宽类型列表
更新时间：2023-12-25 GMT+08:00
查看PDF
分享

查询指定租户下的共享带宽类型列表

功能介绍

查询指定租户下的共享带宽类型列表

URI

GET /v3/{project_id}/eip/share-bandwidth-types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String
  • 功能说明：项目id

最小长度：0

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

fields

否

String
  • 功能说明：查询字段，形式为"fields=id&fields=bandwidth_type&..."
  • 支持字段：id/bandwidth_type/name_en/name_zh/created_at/update_at/public_border_group/description

最小长度：0

最大长度：1024

id

否

String
  • 功能说明：支持带宽类型的id

最小长度：0

最大长度：36

bandwidth_type

否

String
  • 功能说明：带宽支持类型

最小长度：1

最大长度：36

name_en

否

String
  • 功能说明：带宽类型英文表述

最小长度：0

最大长度：256

name_zh

否

String
  • 功能说明：带宽类型中文表述

最小长度：0

最大长度：256

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
  • 功能说明：每页返回的个数
  • 取值范围：0~[2000]，其中2000为局点差异项，具体取值由局点决定

最小值：0

最大值：2000

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

share_bandwidth_types

Array of ShareBandwidthTypeShowResp objects

共享带宽类型对象

request_id

String

本次请求的编号

page_info

PageInfoOption object

分页页码信息
表4 ShareBandwidthTypeShowResp

参数

参数类型

描述

id

String

支持带宽类型的id

最小长度：0

最大长度：36

bandwidth_type

String

带宽类型

最小长度：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
表5 PageInfoOption

参数

参数类型

描述

previous_marker

String

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

最小长度：0

最大长度：36

next_marker

String

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

最小长度：0

最大长度：36

current_count

Integer

当前页的数据总数

最小值：0

最大值：99999

请求示例

无

响应示例

状态码： 200

GET操作正常返回

{
  "share_bandwidth_types" : [ {
    "id" : "1b478471-eaf1-4a71-9c77-edba89f62016",
    "bandwidth_type" : "share",
    "name_en" : "share_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",
    "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
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 共享带宽类型