Query EIPGROUP details
Updated at:2025-10-16
- Retrieve EIPGROUP details.
Request structure
Plain Text
1GET /v{version}/eipgroup/{id} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization string
Request 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 | Yes | URL parameter | ID of the EIPGROUP to be queried |
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 |
|---|---|---|
| id | String | EIPGROUP ID |
| name | String | EIPGROUP name |
| eips | List<[EipModel](EIP/API Reference/Appendix 1.md#EipModel)> | IPv4 EIP instance list |
| eipv6s | List<[EipModel](EIP/API Reference/Appendix 1.md#EipModel)> | IPv6 EIP instance list |
| status | [EipGroupStatus](EIP/API Reference/Appendix 1.md#EipGroupStatus) | EIPGROUP status |
| bandwidthInMbps | int | Public network bandwidth, in Mbps |
| defaultDomesticBandwidth | int | Defaulted as cross-border acceleration bandwidth, in Mbps |
| bwShortId | String | Bandwidth package ID |
| bwBandwidthInMbps | int | Total bandwidth of bandwidth package, in Mbps |
| domesticBwShortId | String | Cross-border acceleration package ID |
| domesticBwBandwidthInMbps | int | Cross-border acceleration package bandwidth, in Mbps |
| paymentTiming | String | Payment time: Prepaid and Postpaid. |
| billingMethod | string | Charge type: ByBandwidth (by bandwidth) or ByPeak95 (95th percentile billing) |
| createTime | String | Creation time |
| expireTime | String | Expiration time (only prepaid products populate this field) |
| region | string | Region to which the EIPGROUP belongs |
| routeType | string | EIPGROUP Internet connection type |
| tags | List<[TagModel](EIP/API Reference/Appendix 1.md#TagModel)> | Collection of tags bound |
Request example
Plain Text
1GET /v1/eipgroup/eg-DCB50385 HTTP/1.1
2HOST eip.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
Response 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 "id":"eg-DCB50385",
10 "name":"eipgroup-for-test",
11 "eips": [
12 {
13 "name":"eip-xrllt5M-1",
14 "eip": "180.181.3.133",
15 "status":"binded",
16 "instanceType": "BCC",
17 "instanceId": "i-IyWRtII7",
18 "shareGroupId": "eg-DCB50385",
19 "eipInstanceType": "shared",
20 "bandwidthInMbps": 5,
21 "paymentTiming":"Prepaid",
22 "billingMethod":null,
23 "createTime":"2016-03-08T08:13:09Z",
24 "expireTime":"2016-04-08T08:13:09Z"
25 }
26 ],
27 "eipv6s":[],
28 "status":"binded",
29 "bandwidthInMbps": 5,
30 "paymentTiming":"Prepaid",
31 "createTime":"2016-03-08T08:13:09Z",
32 "expireTime":"2016-04-08T08:13:09Z",
33 "tags": [
34 {
35 "tagKey": "tagK",
36 "tagValue": "tagV"
37 }
38 ]
39}
