Creating an IP Address Group

Function

This API is used to create an IP address group. You can associate the IP address group with a listener to control access to this listener.

Each IP address group can contain IP addresses, IP address ranges, and CIDR blocks. Each IP address range must be in the format of ip-ip, for example, 10.12.3.1-10.12.3.10. Both IPv4 and IPv6 addresses are supported.

Note: 0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, either one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1, and ::1/128, only one will be kept.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/ipgroups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
ipgroup	Yes	CreateIpGroupOption object	Definition: Specifies the request parameters for creating an IP address group. Constraints: N/A

**Table 4** CreateIpGroupOption
Parameter	Mandatory	Type	Description
project_id	No	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A NOTE: This parameter is invalid. The project ID in the URL is used.
description	No	String	Definition: Provides supplementary information about an IP address group. Constraints: N/A Range: 0 to 255 characters. Default value: N/A
name	No	String	Definition: Specifies the name of an IP address group. Constraints: N/A Range: 0 to 255 characters. Default value: N/A
ip_list	Yes	Array of CreateIpGroupIpOption objects	Definition: Specifies entries in the IP address group. Both IPv4 and IPv6 entries are supported. Constraints: N/A Range: 0 to 300 entries. Default value: N/A
enterprise_project_id	No	String	Definition: Specifies the ID of the enterprise project. If no enterprise project ID is specified during resource creation, 0 is returned, indicating that the resource belongs to the default enterprise project. Constraints: The enterprise project ID cannot be "", 0, or an enterprise project ID that does not exist. Range: N/A Default value: 0

**Table 5** CreateIpGroupIpOption
Parameter	Mandatory	Type	Description
ip	Yes	String	Definition: Specifies the IP entries in the IP address group. Constraints: N/A Range: Each entry can be an IP address, IP address range, or CIDR block. Each IP address range must be in the format of ip-ip, for example, 192.168.1.2-192.168.2.253 or 2001:0DB8:02de::0e12-2001:0DB8:02de::0e13. Both IPv4 and IPv6 addresses are supported. Default value: N/A
description	No	String	Definition: Specifies remarks about the IP address group. Constraints: N/A Range: 0 to 255 characters. Default value: N/A

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
ipgroup	IpGroup object	Definition: Specifies the response body for creating an IP address group.
request_id	String	Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).

**Table 7** IpGroup
Parameter	Type	Description
id	String	Definition: Specifies the ID of an IP address group. Range: N/A
name	String	Definition: Specifies the name of an IP address group. Range: N/A
description	String	Definition: Provides supplementary information about an IP address group. Range: N/A
ip_list	Array of IpInfo objects	Definition: Specifies IP addresses in an IP address group. [] indicates any IP address.
listeners	Array of ListenerRef objects	Definition: Specifies the IDs of listeners with which the IP address group is associated.
project_id	String	Definition: Specifies the project ID of the IP address group. Range: N/A
enterprise_project_id	String	Definition: Specifies the ID of the enterprise project. Range: 0: The resource belongs to the default enterprise project. A string in UUID format indicates a non-default enterprise project.
created_at	String	Definition: Specifies the time when the IP address group was created. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format.
updated_at	String	Definition: Specifies the time when the IP address group was updated. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

**Table 8** IpInfo
Parameter	Type	Description
ip	String	Definition: Specifies the IP entries in the IP address group. Range: Each IP address range must be in the format of ip-ip, for example, 192.168.1.2-192.168.2.253 or 2001:0DB8:02de::0e12-2001:0DB8:02de::0e13. The end IP address must be greater than the start IP address.
description	String	Definition: Provides remarks about the IP address group. Range: 0 to 255 characters.

**Table 9** ListenerRef
Parameter	Type	Description
id	String	Definition: Specifies the listener ID. Range: N/A

Example Requests

Creating an IP address group and specifying IP addresses

POST https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups

{
  "ipgroup" : {
    "name" : "test_ipg",
    "ip_list" : [ {
      "ip" : "192.168.1.123"
    }, {
      "ip" : "192.168.3.0/24",
      "description" : "test_ip"
    }, {
      "ip" : "2001:0DB8:02de:0000:0000:0000:0000:0e13"
    } ]
  }
}

Example Responses

Status code: 201

Normal response to POST requests.

{
  "ipgroup" : {
    "description" : "",
    "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
    "name" : "test_ipg",
    "project_id" : "45977fa2dbd7482098dd68d0d8970117",
    "ip_list" : [ {
      "ip" : "192.168.1.123",
      "description" : ""
    }, {
      "ip" : "192.168.3.0/24",
      "description" : "test_ip"
    } ],
    "listeners" : [ {
      "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
    }, {
      "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
    } ],
    "created_at" : "2018-01-16T03:19:16",
    "updated_at" : "2018-01-16T03:19:16"
  }
}