Creating an IP Address Group

Function

An IP address group is a collection of IP addresses. It can be associated with security groups and network ACLs to simplify IP address configuration and management in networking. You can create an IP address group to centrally manage IP address ranges and IP addresses.

Constraints

The default IP address group quota for each account is 50.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/vpc/address-groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: ID of the project that an IP address group belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
dry_run	No	Boolean	Definition: Whether to only check the request. Constraints: N/A Range: true: A check request will be sent and no IP address group will be created. Check items include mandatory parameters, request format, and constraints. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned. false: A request will be sent and an IP address group will be created. Default Value: false
address_group	Yes	CreateAddressGroupOption object	Definition: Request body for creating an IP address group. Constraints: N/A Range: N/A Default Value: N/A

**Table 3** CreateAddressGroupOption
Parameter	Mandatory	Type	Description
name	Yes	String	Definition: The name of an IP address group. Constraints: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods. Range: N/A Default Value: N/A
description	No	String	Definition: Description about an IP address group. Constraints: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). Range: N/A Default Value: N/A
ip_version	Yes	Integer	Definition: IP address version of an IP address group. Constraints: N/A Range: 4: IPv4 address group 6: IPv6 address group Default Value: N/A
max_capacity	No	Integer	Definition: Maximum number of IP address entries in an IP address group. Constraints: N/A Range: 0 to 20 Default Value: 20
ip_set	No	Array of strings	Definition: IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported. Constraints: The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group is 20. The ip_set and ip_extra_set parameters cannot be both specified in a request. If you need to add remarks for IP address entries, use the ip_extra_set parameter. Range: An IP address entry in an IP address set can be: A single IP address, for example, 192.168.21.25 An IP address range, for example, 192.168.21.25-192.168.21.30 A CIDR block, for example, 192.168.21.0/24 Default Value: N/A
ip_extra_set	No	Array of IpExtraSetOption objects	Definition: IP address entries in an IP address group and their remarks. There are multiple IP address entry objects in an IP address group. Each IP address entry object contains one IP address entry and its remarks. An IP address entry is the same as that in ip_set. The remarks can describe the usage of the IP address entry. Constraints: By default, the maximum number of IP address entry objects is 20. The ip_set and ip_extra_set parameters cannot be both specified in a request. If you need to add remarks for IP address entries, use the ip_extra_set parameter. Range: N/A Default Value: N/A

**Table 4** IpExtraSetOption
Parameter	Mandatory	Type	Description
ip	Yes	String	Definition: IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported. Constraints: N/A Range: A single IP address, for example, 192.168.21.25 An IP address range, for example, 192.168.21.25-192.168.21.30 A CIDR block, for example, 192.168.21.0/24 Default Value: N/A
remarks	No	String	Definition: Remarks of an IP address entry. Constraints: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). Range: N/A Default Value: N/A

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Definition: Request ID. Range: N/A
address_group	AddressGroup object	Definition: Response body for creating an IP address group. Range: N/A

**Table 6** AddressGroup
Parameter	Type	Description
id	String	Definition: ID of an IP address group. After an IP address group is created, an IP address group ID is generated, which uniquely identifies the IP address group. Range: The value is in UUID format with hyphens (-).
name	String	Definition: The name of an IP address group. Range: The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods.
description	String	Definition: Description about an IP address group. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).
max_capacity	Integer	Definition: Maximum number of IP address entries in an IP address group. Range: The value can be from 0 to 20. The default value is 20.
ip_set	Array of strings	Definition: IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported. Range: An IP address entry in an IP address set can be: A single IP address, for example, 192.168.21.25 An IP address range, for example, 192.168.21.25-192.168.21.30 A CIDR block, for example, 192.168.21.0/24
ip_version	Integer	Definition: IP address version of an IP address group. Range: 4: IPv4 address group 6: IPv6 address group
created_at	String	Definition: Time when an IP address group was created. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.
updated_at	String	Definition: Time when an IP address group was last updated. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.
tenant_id	String	Definition: ID of the project that an IP address group belongs to. Range: N/A
enterprise_project_id	String	Definition: ID of the enterprise project that an IP address group belongs to. Range: The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.
tags	Array of ResponseTag objects	Definition: Tags of an IP address group, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. Range: N/A
status	String	Definition: Status of an IP address group. If the IP address group is in the UPDATING state, it cannot be updated again. Range: NORMAL: normal (default value) UPDATING: being updated UPDATE_FAILED: update failed
status_message	String	Definition: Details about the IP address group status. Range: N/A
ip_extra_set	Array of IpExtraSetRespOption objects	Definition: IP address entries in an IP address group and their remarks. Range: N/A

**Table 7** ResponseTag
Parameter	Type	Description
key	String	Definition: Tag key. Range: A tag key can contain a maximum of 128 Unicode characters and cannot be left blank. Each tag key of a resource must be unique. The value can contain: Letters Digits Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=) Chinese characters
value	String	Definition: Tag value. Range: Each value can contain a maximum of 255 Unicode characters and can be left blank. The value can contain: Letters Digits Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=) Chinese characters

**Table 8** IpExtraSetRespOption
Parameter	Type	Description
ip	String	Definition: IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported. Range: A single IP address, for example, 192.168.21.25 An IP address range, for example, 192.168.21.25-192.168.21.30 A CIDR block, for example, 192.168.21.0/24
remarks	String	Definition: Remarks of an IP address entry. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

Example Requests

Create an IP address group named AutoTester746010.580123789, set the IP address 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",
    "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" ],
    "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
    } ],
    "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" : "",
    "tags" : [ ]
  },
  "request_id" : "f568db7a-2675-4271-8747-3e3f1c6381ba"
}