Create IP address family
Updated at：2025-10-16
Description
This API is used to create IP address families.
Request structure
Plain Text
1POST /v{version}/ipGroup?clientToken={clientToken} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "name":{name},
6 "ipVersion":{ipVersion},
7 "ipSetIds":{ipSetIds},
8 "description":{description}
9}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number, with current value being 1. |
| name | String | Yes | RequestBody | IP address family name, which supports uppercase and lowercase letters, numbers, and special characters such as -, _, / and ., starting with a letter or Chinese and a length of 1-65. |
| ipVersion | String | Yes | RequestBody | ipVersion, value: IPv4 or IPv6 |
| ipSetIds | List<String> | Yes | Request Body parameters | ID of the associated IP address group (ipVersion must match the IP address family created), with a maximum of 5 entries per operation |
| description | String | No | RequestBody | IP address family description, with a maximum length of 255 characters |
| clientToken | String | No | Query | Idempotence Token, which is an ASCII string with a length not exceeding 64 bits, see details in [ClientToken IdempotenceSupport](VPC/API Reference/General Description.md#Idempotence). |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| ipGroupId | String | ID of the IP address family |
Request example
Plain Text
1POST /v1/ipGroup?clientToken=cecad37a-5a1e-4135-a1bc-b1a105d12dec HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "name":"ipGroup_test",
6 "ipVersion":"IPv4",
7 "ipSetIds": ["ips-q52nhx0fqqmk"],
8 "description":"desc"
9}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7e789a40-adac-414a-8bd4-916d6be61112
3Date: Mon, 02 Apr 2019 08:14:25 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "ipGroupId":"ipg-pcpvtee8kd6b"
8}