Creating an IP Address Group
Function
This API is used to create an IP address group.
Constraints
The default IP address group quota for each account is 50.
URI
POST /v3/{project_id}/vpc/address-groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Request Parameter
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dry_run |
No |
Boolean |
|
address_group |
Yes |
CreateAddressGroupOption object |
Request body for creating an IP address group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
|
description |
No |
String |
|
ip_version |
Yes |
Integer |
|
max_capacity |
No |
Integer |
|
ip_set |
No |
Array of strings |
|
enterprise_project_id |
No |
String |
|
ip_extra_set |
No |
Array of IpExtraSetOption objects |
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ip |
Yes |
String |
|
remarks |
No |
String |
|
Example Request
- Create an IP address group named AutoTester746010.580123789, set the IP version to IPv4, and the IP set to 192.168.3.2, 192.168.3.40, 192.168.3.20-192.168.3.100, and 192.168.5.0/24.
POST https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups { "address_group": { "ip_version": 4, "name": "AutoTester746010.580123789", "ip_set": [ "192.168.3.2", "192.168.3.40", "192.168.3.20-192.168.3.100", "192.168.5.0/24" ], "description": "test", "max_capacity": 20, "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
Response Parameter
When the status code is 201, the response parameters are as follows:
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
address_group |
AddressGroup object |
Response body for creating an IP address group. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
name |
String |
|
description |
String |
|
ip_set |
Array of strings |
|
ip_version |
Integer |
|
created_at |
String |
|
updated_at |
String |
|
tenant_id |
String |
|
max_capacity |
Integer |
|
enterprise_project_id |
String |
|
tags |
Array of ResourceTag objects |
IP address group tags. |
status |
String |
|
status_message |
String |
|
ip_extra_set |
Array of IpExtraSetRespOption objects |
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
|
value |
String |
|
Parameter |
Type |
Description |
---|---|---|
ip |
String |
|
remarks |
String |
|
Example Response
When the status code is 201, the response parameters are as follows:
{ "address_group": { "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name": "AutoTester746010.580123789", "tenant_id": "b2782e6708b8475c993e6064bc456bf8", "ip_version": 4, "ip_set": [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ], "ip_extra_set": [{ "ip": "192.168.5.0/24", "remarks": null }, { "ip": "192.168.3.20-192.168.3.100", "remarks": null }, { "ip": "192.168.3.40", "remarks": null }, { "ip": "192.168.3.2", "remarks": null }], "created_at": "2019-06-28T02:06:38", "updated_at": "2019-06-28T02:06:38", "description": "test", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "tags": [], "max_capacity": 20, "status": "NORMAL", "status_message": "" }, "request_id": "f568db7a-2675-4271-8747-3e3f1c6381ba" }
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot