Query EIP list
Updated at：2025-10-16
- The EIP list can be filtered using various criteria.
- To view details of a specific EIP, only the eip parameter is needed.
- To see EIPs linked to a particular instance type, only the instanceType parameter is required.
- To view details of EIPs tied to a specific instance, you need to provide both the instanceType and instanceId parameters.
- If no specific criteria are specified, all EIPs will be listed by default.
- The returned results are based on the overlap of multiple conditions, meaning that if multiple conditions are set, the query will return only the EIPs that meet all conditions.
- The query results support marker-based pagination, with a default page size of 1,000. You can adjust this by setting the maxKeys parameter.
Request structure
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 stringNo special headers beyond common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number, current value is 1. |
| ipVersion | String | No | Query | The type of EIP to query can be either IPv4 or IPv6, with IPv4 being the default. |
| eip | String | No | Query | EIPs to query include both IPv4 and IPv6. To query a specific IPv6 EIP, set the ipVersion to IPv6. |
| instanceType | String | No | Query | Type of bound instance, with value range being BCC, BBC, DCC, ENI, BLB, NAT, and VPN |
| instanceId | String | No | Query | Short ID of the bound instance. If this parameter is specified, the instanceType parameter must also be provided simultaneously |
| name | String | No | Query | EIP name to be queried |
| status | String | No | Query | Instance status, only supporting queries for three statuses of available, binded, and paused |
| eipIds | List |
No | Query | Short ID of the EIP, supporting query by single EIP ID or multiple EIP IDs (separated by commas) |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | int | No | Query | Maximum number of items per page is 1,000, with a default value of 1000. |
Response Status Code
Respond with 200 after successful operation, and respond with error codes after failed operation, as shown in [Error Codes](EIP/API Reference/Error code.md)
Response headers
No special headers beyond common headers.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| eipList | List<[EipModel](EIP/API Reference/Appendix 1.md#EipModel)> | List containing query results |
| marker | string | Marker indicating the starting position of the query. If the result list is empty, this field does not exist. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
Request example: Query IPv4 EIP list
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/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02Request example: Query IPv6 EIP list
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/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02Response example: Query IPv4 EIP list
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}Response example: Query IPv6 EIP list
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}