Create EIPGROUP
Updated at：2025-10-16
- Create an EIPGROUP.
- Real-time certification is required for creating EIPGROUP. Those who have not passed real-time certification can access the real-time certification under security certification in the Baidu Open Cloud Official Website Console for certification.
- Currently, only prepaid EIPGROUP creation is supported.
Request structure
Plain Text
1POST /v{version}/eipgroup?clientToken={clientToken} HTTP/1.1
2Host: eip.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": name,
7 "eipCount": eipCount,
8 "eipv6Count": eipv6Count,
9 "bandwidthInMbps": bandwidthInMbps,
10 "billing":{
11 "paymentTiming": paymentTiming,
12 "billingMethod": billingMethod,
13 "reservation":{
14 "reservationLength": reservationLength,
15 "reservationTimeUnit": reservationTimeUnit
16 }
17 },
18 "tags":[
19 {
20 "tagKey": tagKey,
21 "tagValue": tagValue
22 }
23 ],
24 "resourceGroupId":resourceGroupId
25}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. |
| clientToken | String | Yes | Query | Idempotence token, for details, refer to [clientToken](EIP/API Reference/General Description.md#Idempotence) |
| routeType | String | No | RequestBody | Line types include Standard BGP (BGP) and Enhanced BGP (BGP_S). If unspecified, it defaults to Standard BGP. |
| eipCount | int | No | RequestBody | The count of IPv4 EIPs in EIPGROUP must be at least 0, with a maximum of n (Standard BGP: n1Mbps less than EIPGROUP capacity; Enhanced BGP: n20Mbps less than EIPGROUP capacity). |
| eipv6Count | int | No | RequestBody | The count of IPv6 EIPs in EIPGROUP must be at least 0, with the maximum controlled by quota and a default value of 1,000. |
| bandwidthInMbps | int | Yes | RequestBody | Public network bandwidth, in Mbps. For prepaid EIPGROUPs, standard BGP is limited to integers within the range of 20~500, while enhanced BGP is limited to integers within the range of 100~5,000 |
| billing | [Billing](EIP/API Reference/Appendix 1.md#Billing) | Yes | RequestBody | Order information |
| name | String | No | RequestBody | Length: 1–65 bytes, starting with a letter. May include letters, numbers, and the characters -\_/. If unspecified, the service will automatically generate a name. |
| tags | List<[TagModel](EIP/API Reference/Appendix 1.md#TagModel)> | No | RequestBody | List of tag key-value pairs to be created. |
| resourceGroupId | String | No | RequestBody | ID of the resource group bound simultaneously when creating EIPGROUP |
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 | Allocated instance ID |
Request example - prepay
Plain Text
1POST /v1/eipgroup?clientToken=f711ab40-fbd8-4148-bbf3-787f40ace866 HTTP/1.1
2HOST eip.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "name":"eipgroup-for-test",
7 "bandwidthInMbps": 1,
8 "billing":{
9 "paymentTiming":"Prepaid",
10 "reservation":{
11 "reservationLength":1,
12 "reservationTimeUnit":"Month"
13 }
14 },
15 "tags":[
16 {
17 "tagKey": "tagK",
18 "tagValue": "tagV"
19 }
20 ],
21 "resourceGroupId":"RESG-J7PdULjguvB"
22}Request example - postpay
Plain Text
1POST /v1/eipgroup?clientToken=f9fcebd4-3e61-4631-bf5a-731e179904c5 HTTP/1.1
2HOST eip.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "name":"eipGroup_test",
7 "eipCount": 1,
8 "eipv6Count": 1,
9 "bandwidthInMbps": 100,
10 "billing":{
11 "paymentTiming":"Postpaid",
12 "billingMethod":"ByBandwidth"
13 }
14}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-b2511000"
10}