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

**Table 1** Parameter description
Name	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

**Table 2** Request body parameter
Parameter	Mandatory	Type	Description
dry_run	No	Boolean	Whether to only send the check request. The value can be: true: A check request will be sent and no IP address group will be created. Check items include mandatory parameters, request format, and permission verification. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned. false (default value): A request will be sent and an IP address group will be created.
address_group	Yes	CreateAddressGroupOption object	Request body for creating an IP address group.

**Table 3** CreateAddressGroupOption
Parameter	Mandatory	Type	Description
name	Yes	String	IP address group name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	No	String	Provides supplementary information about an IP address group. The value can contain up to 255 characters and cannot contain angle brackets (< or >).
ip_version	Yes	Integer	The IP version of the address group. The value can be: 4: IPv4 address group. 6: IPv6 address group.
ip_set	No	Array of strings	IP address sets in an IP address group. The value can be a single IP address, IP address range, or CIDR block. The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group is 20.

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"
    }
}

Response Parameter

When the status code is 201, the response parameters are as follows:

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
address_group	AddressGroup object	Response body for creating an IP address group.

**Table 5** AddressGroup
Parameter	Type	Description
id	String	IP address group ID that uniquely identifies the IP address group. The value is a string in UUID format.
name	String	IP address group name. The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Provides supplementary information about an IP address group. The value can contain up to 255 characters. The value cannot contain angle brackets (< or >).
ip_set	Array of strings	IP address sets in an IP address group. The value can be a single IP address, IP address range, or CIDR block. The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group is 20.
ip_version	Integer	Whether it is an IPv4 or IPv6 address group. The value can be: 4: IPv4 address group. 6: IPv6 address group.
created_at	String	Time (UTC) when the IP address group is created. The value must be the UTC time in the format of yyyy-MM-ddTHH:mmss.
updated_at	String	Time (UTC) when the IP address group was last updated. The value must be the UTC time in the format of yyyy-MM-ddTHH:mmss.
tenant_id	String	ID of the project to which the IP address group belongs.

Example Response

When the status code is 201, the response parameters are as follows:

Normal response for the POST operation of the API for creating an IP address group

{
    "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"
        ], 
        "created_at": "2019-06-28T02:06:38", 
        "updated_at": "2019-06-28T02:06:38", 
        "description": "test"
    }, 
    "request_id": "f568db7a-2675-4271-8747-3e3f1c6381ba"
}