查询共享带宽列表
更新时间:2023-08-31
- 可根据多重条件查询共享带宽列表。
- 若不提供查询条件,则默认查询覆盖所有EIP。
- 返回结果为多重条件交集的查询结果,即提供多重条件的情况下,返回同时满足所有条件的共享带宽。
- 以上查询结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定。
请求结构
GET /v{version}/eipgroup?id={id}&name={name}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1 |
id | String | 否 | Query参数 | 要查询的共享带宽的ID |
name | String | 否 | Query参数 | 要查询的共享带宽的名称 |
status | String | 否 | Query参数 | 要查询的共享带宽的状态 |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串 |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000。缺省值为1000 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
eipgroups | List<EipGroupModel> | 包含查询结果的列表 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
maxKeys | int | 每页包含的最大数量 |
请求示例
GET /v1/eipgroup?maxKeys=1 HTTP/1.1
HOST eip.bj.baidubce.com
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: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"eipgroups": [
{
"id":"eg-DCB50385",
"name":"eipgroup-for-test",
"eips": [
{
"name":"eip-xrllt5M-1",
"eip": "180.181.3.133",
"status":"binded",
"instanceType": "BCC",
"instanceId": "i-IyWRtII7",
"shareGroupId": "eg-DCB50385",
"eipInstanceType": "shared",
"bandwidthInMbps": 5,
"paymentTiming":"Prepaid",
"billingMethod":null,
"createTime":"2016-03-08T08:13:09Z",
"expireTime":"2016-04-08T08:13:09Z"
},
],
"status":"binded",
"bandwidthInMbps": 5,
"paymentTiming":"Prepaid",
"createTime":"2016-03-08T08:13:09Z",
"expireTime":"2016-04-08T08:13:09Z"
}
],
"marker":"eg-DCB50385",
"isTruncated": true,
"nextMarker": "eg-DCB50387",
"maxKeys": 2
}
文档反馈