查询EIP列表
更新时间：2024-08-08
- 可根据多重条件查询EIP列表。
- 如只需查询单个EIP的详情，只需提供eip参数即可。
- 如只需查询绑定到指定类型实例上的EIP，提供instanceType参数即可。
- 如只需查询指定实例上绑定的EIP的详情，提供instanceType及instanceId参数即可。
- 若不提供查询条件，则默认查询覆盖所有EIP。
- 返回结果为多重条件交集的查询结果，即提供多重条件的情况下，返回同时满足所有条件的EIP。
- 以上查询结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定。
请求结构
GET /v{version}/eip?eip={eip}&instanceType={instanceType}&instanceId={instanceId}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: eip.bj.baidubce.com
Authorization: authorization string除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| eip | String | 否 | Query参数 | 要查询的EIP，点分十进制表示 |
| instanceType | String | 否 | Query参数 | 绑定实例类型.取值 BCC、BBC、DCC、ENI、BLB、NAT、VPN |
| instanceId | String | 否 | Query参数 | 实例短ID，若指定了此参数，需同时提供instanceType参数 |
| name | String | 否 | Query参数 | 要查询的EIP名称 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000。缺省值为1000 |
| status | String | 否 | Query参数 | 实例状态，仅支持available, binded, paused三种状态的查询 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| eipList | List<EipModel> | 包含查询结果的列表 |
| marker | string | 标记查询的起始位置，若结果列表为空，此项不存在 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
请求示例
GET /v1/eip?instanceType=BCC&maxKeys=2 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
{
"eipList": [
{
"name":"eip-xrllt5M-1",
"eip": "180.181.3.133",
"eipId": "ip-xxxxxxxx",
"status":"binded",
"instanceType": "BCC",
"instanceId": "i-IyWRtII7",
"shareGroupId": "eg-0c31c93a",
"eipInstanceType": "shared",
"bandwidthInMbps": 5,
"paymentTiming":"Prepaid",
"billingMethod":null,
"createTime":"2016-03-08T08:13:09Z",
"expireTime":"2016-04-08T08:13:09Z",
"region":"bj",
"routeType":"BGP",
"tags": [
{
"tagKey": "aa",
"tagValue": "bb"
}
],
"deleteProtect":true
},
{
"name":"eip-scewa1M-1",
"eip": "180.181.3.134",
"eipId": "ip-xxxxxxxx",
"status":"binded",
"instanceType": "BCC",
"instanceId": "i-KjdgweC4",
"shareGroupId": null,
"eipInstanceType": "normal",
"bandwidthInMbps": 1,
"paymentTiming":"Postpaid",
"billingMethod":"ByTraffic",
"createTime":"2016-03-08T08:13:09Z",
"expireTime":null,
"region":"bj",
"routeType":"BGP",
"tags": [
{
"tagKey": "key",
"tagValue": "value"
}
],
"deleteProtect":false
}
],
"marker":"eip-DCB50385",
"isTruncated": true,
"nextMarker": "eip-DCB50387",
"maxKeys": 2
}