查询EIP列表
更新时间：2025-05-08
- 可根据多重条件查询EIP列表。
- 如只需查询单个EIP的详情，只需提供eip参数即可。
- 如只需查询绑定到指定类型实例上的EIP，提供instanceType参数即可。
- 如只需查询指定实例上绑定的EIP的详情，提供instanceType及instanceId参数即可。
- 若不提供查询条件，则默认查询覆盖所有EIP。
- 返回结果为多重条件交集的查询结果，即提供多重条件的情况下，返回同时满足所有条件的EIP。
- 以上查询结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定。
请求结构
Plain Text
1GET /v{version}/eip?ipVersion={ipVersion}&eip={eip}&instanceType={instanceType}&instanceId={instanceId}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization string除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| ipVersion | String | 否 | Query参数 | 要查询的EIP IP类型，包含ipv4和ipv6，默认ipv4。 |
| eip | String | 否 | Query参数 | 要查询的EIP，包括IPv4 EIP和IPv6 EIP,如需查询指定IPv6 EIP，需要指定ipVersion为ipv6。 |
| instanceType | String | 否 | Query参数 | 绑定实例类型.取值 BCC、BBC、DCC、ENI、BLB、NAT、VPN |
| instanceId | String | 否 | Query参数 | 绑定实例的短ID，若指定了此参数，需同时提供instanceType参数 |
| name | String | 否 | Query参数 | 要查询的EIP名称 |
| status | String | 否 | Query参数 | 实例状态，仅支持available, binded, paused三种状态的查询 |
| eipIds | List |
否 | Query参数 | EIP短ID，支持单EIP ID或者多EIP ID查询（多个EIP ID用英文逗号隔开） |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000。缺省值为1000 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| eipList | List<EipModel> | 包含查询结果的列表 |
| marker | string | 标记查询的起始位置，若结果列表为空，此项不存在 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
请求示例, 查询IPv4 EIP列表
Plain Text
1GET /v1/eip?instanceType=BCC&maxKeys=2 HTTP/1.1
2HOST eip.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02请求示例, 查询IPv6 EIP列表
Plain Text
1GET /v1/eip?ipVersion=ipv6&eip=240c:4082:ffff:ff01:0:4:0:12a HTTP/1.1
2HOST eip.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例, 查询IPv4 EIP列表
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "eipList": [
10 {
11 "name":"eip-xrllt5M-1",
12 "eip": "180.181.3.133",
13 "eipId": "ip-xxxxxxxx",
14 "status":"binded",
15 "instanceType": "BCC",
16 "instanceId": "i-IyWRtII7",
17 "shareGroupId": "eg-0c31c93a",
18 "eipInstanceType": "shared",
19 "bandwidthInMbps": 5,
20 "paymentTiming":"Prepaid",
21 "billingMethod":null,
22 "createTime":"2016-03-08T08:13:09Z",
23 "expireTime":"2016-04-08T08:13:09Z",
24 "region":"bj",
25 "routeType":"BGP",
26 "tags": [
27 {
28 "tagKey": "aa",
29 "tagValue": "bb"
30 }
31 ],
32 "deleteProtect":true
33 },
34 {
35 "name":"eip-scewa1M-1",
36 "eip": "180.181.3.134",
37 "eipId": "ip-xxxxxxxx",
38 "status":"binded",
39 "instanceType": "BCC",
40 "instanceId": "i-KjdgweC4",
41 "shareGroupId": null,
42 "eipInstanceType": "normal",
43 "bandwidthInMbps": 1,
44 "paymentTiming":"Postpaid",
45 "billingMethod":"ByTraffic",
46 "createTime":"2016-03-08T08:13:09Z",
47 "expireTime":null,
48 "region":"bj",
49 "routeType":"BGP",
50 "tags": [
51 {
52 "tagKey": "key",
53 "tagValue": "value"
54 }
55 ],
56 "deleteProtect":false
57 }
58 ],
59 "marker":"eip-DCB50385",
60 "isTruncated": true,
61 "nextMarker": "eip-DCB50387",
62 "maxKeys": 2
63}响应示例, 查询IPV6 EIP列表
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 029433e5-3264-4ed0-9cbf-f4b85a468f00
3Date: Wed, 10 Apr 2024 01:10:53 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "marker": "eipv6-4NOa3gC9",
10 "isTruncated": false,
11 "nextMarker": null,
12 "maxKeys": 1000,
13 "eipList": [
14 {
15 "name": "eip_v6_test",
16 "eip": "240c:4082:ffff:ff01:0:4:0:12a",
17 "eipId": "eipv6-XXX",
18 "status": "available",
19 "instanceType": null,
20 "instanceId": null,
21 "routeType": "BGP",
22 "bwBandwidthInMbps": 0,
23 "domesticBwBandwidthInMbps": 0,
24 "clusterId": "c-76a34e7b",
25 "bandwidthInMbps": 150,
26 "paymentTiming": "Postpaid",
27 "billingMethod": "ByBandwidth",
28 "exclusiveCluster": false,
29 "createTime": "2024-04-10T09:30:25Z",
30 "expireTime": null,
31 "shareGroupId": "",
32 "eipInstanceType": "normal",
33 "tags": null,
34 "region": "bd",
35 "poolType": null
36 }
37 ]
38}