查询回收站内EIP列表
更新时间:2023-08-31
查询回收站内EIP列表
描述
- 查询用户账号下回收站内EIP信息。
- 支持按EIP的eip、name进行查询,eip、name 均支持模糊搜索。
- 若不提供查询条件,则默认查询覆盖所有EIP。
- 返回结果是多重条件交集的查询结果,即提供多重条件的情况下,返回同时满足所有条件的EIP。
- 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定。
请求结构
GET /v{version}/eip/recycle?eip={eip}&name={name}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域
请求参数
参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,当前取值1。 |
eip | String | 否 | Query参数 | 要查询的EIP,点分十进制表示。 |
name | String | 否 | Query参数 | 要查询的EIP名称。 |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置,是一个由系统生成的字符串。 |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量不超过1000,缺省值为1000。 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
eipList | List<RecycleEipModel> | 包含查询结果的列表。 |
marker | String | 标记查询的起始位置,若结果列表为空,此项不存在。 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页。 |
nextMarker | String | 获取下一页所需要传递的marker值,当isTruncated为false时,该域不出现。 |
maxKeys | int | 每页包含的最大数量。 |
请求示例
GET /v1/eip/recycle?marker=ip-1dd4f675&maxKeys=1 HTTP/1.1
Host: eip.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2022-02-14T02:14:00Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
响应示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Tue, 14 Feb 2022 02:14:03 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nextMarker": "ip-d51ec70b",
"marker": "ip-1dd4f675",
"maxKeys": 1,
"isTruncated": true,
"eipList": [
{
"name":"eip-xxxx-1",
"eip": "180.181.3.133",
"eipId": "ip-xxxxxxxx",
"status": "paused",
"routeType":"BGP",
"bandwidthInMbps": 5,
"paymentTiming":"Postpaid",
"billingMethod":"ByTraffic",
"recycleTime":"2022-02-13T04:28:00Z",
"scheduledDeleteTime":"2022-02-20T04:28:00Z",
}
]
}