Query the EIPGROUP list
Updated at：2025-10-16
- Retrieve the EIPGROUP list based on multiple criteria.
- If no specific criteria are specified, all EIPs will be listed by default.
- Results are based on the intersection of criteria, meaning when multiple conditions are specified, only EIPGROUPs meeting all conditions are returned.
- 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}/eipgroup?id={id}&name={name}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization stringRequest headers
No 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. |
| id | String | No | Query | ID of the EIPGROUP to be queried |
| name | String | No | Query | Name of the EIPGROUP to be queried |
| status | String | No | Query | Status of the EIPGROUP to be queried |
| 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 |
|---|---|---|
| eipgroups | List<[EipGroupModel](EIP/API Reference/Appendix 1.md#EipGroupModel)> | 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
Plain Text
1GET /v1/eipgroup?maxKeys=1 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
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 "eipgroups": [
10 {
11 "id":"eg-DCB50385",
12 "name":"eipgroup-for-test",
13 "eips": [
14 {
15 "name":"eip-xrllt5M-1",
16 "eip": "180.181.3.133",
17 "status":"binded",
18 "instanceType": "BCC",
19 "instanceId": "i-IyWRtII7",
20 "shareGroupId": "eg-DCB50385",
21 "eipInstanceType": "shared",
22 "bandwidthInMbps": 5,
23 "paymentTiming":"Prepaid",
24 "billingMethod":null,
25 "createTime":"2016-03-08T08:13:09Z",
26 "expireTime":"2016-04-08T08:13:09Z"
27 },
28 ],
29 "eipv6s": [],
30 "status":"binded",
31 "bandwidthInMbps": 5,
32 "paymentTiming":"Prepaid",
33 "createTime":"2016-03-08T08:13:09Z",
34 "expireTime":"2016-04-08T08:13:09Z"
35 }
36 ],
37 "marker":"eg-DCB50385",
38 "isTruncated": true,
39 "nextMarker": "eg-DCB50387",
40 "maxKeys": 2
41}