Creating an IP Address Group

Updated on 2024-10-31 GMT+08:00

View PDF

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** Path Parameters
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 Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
dry_run	No	Boolean	Whether to only send the check request. The value can be one of the following: true: A check request will be sent and the IP address group will not be created. Check items include mandatory parameters, request format, and constraints. If the check fails, the system returns an error. 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	Description about the IP address group. The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
ip_version	Yes	Integer	Whether it is an IPv4 or IPv6 address group. The value can be: 4, IPv4 address groups. 6, IPv6 address groups.
max_capacity	No	Integer	Maximum number of entries in an IP address group. Each entry can be an IP address, IP address range, or CIDR block. The value can be from 0 to 20. The default value is 20.
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.

Response Parameters

Status code: 201

**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 no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Description about the IP address group. The value can contain no more than 255 characters. The value cannot contain angle brackets (< or >).
max_capacity	Integer	Maximum number of entries in an IP address group. Each entry can be an IP address, IP address range, or CIDR block. The value can be from 0 to 20. The default value is 20.
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 one of the following: 4 (IPv4 address groups). 6 (IPv6 address groups).
created_at	String	Time when the IP address group was created. The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss, which is automatically generated by the system.
updated_at	String	Time when the IP address group was last updated. The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss, which is automatically generated by the system.
tenant_id	String	ID of the project where the IP address group is used.
enterprise_project_id	String	Enterprise project ID. The project ID can be 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project. Maximum: 36
tags	Array of ResourceTag objects	IP address group tags.
status	String	IP address group status. The value can be one of the following: NORMAL: The IP address group is normal. UPDATING: The IP address group is being updated. UPDATE_FAILED: Updating the IP address group failed. The default value is NORMAL. An IP address group in the UPDATING status cannot be updated again.
status_message	String	Details of the IP address group status.

**Table 6** ResourceTag
Parameter	Type	Description
key	String	Tag key Tag keys must be unique for each resource. Minimum: 1 Maximum: 128
value	String	Tag value. Maximum: 255

Example Requests

Create an IP address group named AutoTester746010.580123789, set the IP version to IPv4, and specify the IP set as 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",
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "max_capacity" : 20
  }
}

Example Responses

Status code: 201

Normal response to the POST operation. For more status codes, see Status Codes.

{
  "address_group" : {
    "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
    "name" : "AutoTester746010.580123789",
    "tenant_id" : "b2782e6708b8475c993e6064bc456bf8",
    "ip_version" : 4,
    "max_capacity" : 20,
    "ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ],
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "created_at" : "2019-06-28T02:06:38.000+00:00",
    "updated_at" : "2019-06-28T02:06:38.000+00:00",
    "description" : "test",
    "status" : "NORMAL",
    "status_message" : ""
  },
  "request_id" : "f568db7a-2675-4271-8747-3e3f1c6381ba"
}