查询用户带宽包列表信息
更新时间：2020-11-11
描述
- 查询用户账户下所有带宽包的信息。
- 支持按带宽包的id、name、bindType进行查询。
- 返回结果是多重查询条件的交集。
- 结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定。
请求结构
GET /v{version}/eipbp?marker={marker}&maxKeys={maxKeys}&id={id}&name={name}&bindType={bindType} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000。缺省值为1000 |
| id | String | 否 | Query参数 | 要查询的带宽包id |
| name | String | 否 | Query参数 | 要查询的带宽包名称 |
| bindType | String | 否 | Query参数 | 要查询的带宽包所绑定的资源的类型，"eip"（弹性公网EIP）或"eipgroup"（共享带宽） |
| type | String | 否 | Query参数 | 带宽包的类型，包括BandwidthPackage（带宽包）和AccelerationPackage（跨境加速包），默认全选 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| bpList | List <BandwidthPackage> | 包含查询结果的列表 |
| marker | String | 标记查询的起始位置，若结果列表为空，此项不存在 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
请求示例
GET /v1/eipbp?marker=bw-IyWRnII7&maxKeys=2 HTTP/1.1
Host: eip.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "bw-IyWRn123",
"marker": "bw-IyWRnII7",
"maxKeys": 2,
"isTruncated": true,
"bpList": [
{
"name":"bp_1",
"id":"bw-IyWRnII7",
"bindType":"eip",
"bandwidthInMbps":"15",
"instanceId":"ip-xefrn257",
"eips":[
"10.23.54.23"
],
"createTime":"2019-08-03T20:38:43Z",
"autoReleaseTime":"2019-08-23T12:38:43Z",
“type”:"BandwidthPackage",
"region":"bj"
},
{
"name":"bp_2",
"id":"bw-IyWRnIqw",
"bindType":"eipgroup",
"bandwidthInMbps":"30",
"instanceId":"eg-xsdqn76f",
"eips":[
"10.23.96.96",
"10.23.96.97",
"10.23.96.98",
"10.23.96.99"
],
"createTime":"2019-08-03T20:38:43Z"，
"autoReleaseTime":"2019-09-23T12:38:43Z",
“type”:"BandwidthPackage",
"region":"bj"
}
]
}BandwidthPackage
| 参数名称 | 类型 | 描述 |
|---|---|---|
| name | String | 带宽包名称 |
| id | String | 带宽包id |
| bindType | String | 带宽包所绑定的资源的类型，"eip"（弹性公网EIP）或"eipgroup"（共享带宽） |
| bandwidthInMbps | int | 带宽包的带宽值 |
| instanceId | String | 带宽包绑定资源的id |
| eips | List <String> | 若bindType为"eip"，只包含一个eip地址；若bindType为"eipgroup"，则包含共享带宽下的全部eip地址 |
| createTime | String | 带宽包创建时间 |
| autoReleaseTime | String | 带宽包的自动释放时间,若未设置则同所绑定资源的到期时间一致 |
| type | String | 带宽包的类型，BandwidthPackage（带宽包）或 AccelerationPackage（跨境加速包） |
region｜String｜带宽包所属区域