Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: zhoumeng <zhoumeng35@huawei.com>
Co-committed-by: zhoumeng <zhoumeng35@huawei.com>

2023-06-09 13:24:32 +00:00

20 KiB

Raw Blame History

Creating an IP Address Group

Function

This API is used to create an IP address group. The IP address can contain IP addresses or CIDR blocks. 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, only 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.

IPv6 is unsupported.

This function is not supported in eu-nl region. Please do not use it.

URI

POST /v3/{project_id}/elb/ipgroups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the token used for IAM authentication.

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

**Table 4** CreateIpGroupOption
Parameter	Mandatory	Type	Description
project_id	No	String	Specifies the project ID of the IP address group. Minimum: 32 Maximum: 32
description	No	String	Provides supplementary information about the IP address group. Minimum: 0 Maximum: 255
name	No	String	Specifies the IP address group name. Minimum: 0 Maximum: 255
ip_list	Yes	Array of CreateIpGroupIpOption objects	Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.
enterprise_project_id	No	String	Specifies the ID of the enterprise project that the IP address group belongs to.

**Table 5** CreateIpGroupIpOption
Parameter	Mandatory	Type	Description
ip	Yes	String	Specifies the IP addresses in the IP address group. IPv6 is unsupported. The value cannot be an IPv6 address.
description	No	String	Provides remarks about the IP address group. Minimum: 0 Maximum: 255

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
ipgroup	IpGroup object	Specifies the response body for creating an IP address group.
request_id	String	Specifies the request ID. The value is automatically generated.

**Table 7** IpGroup
Parameter	Type	Description
created_at	String	Specifies the time when the IP address group was created.
description	String	Specifies the time when the IP address group was updated.
id	String	Specifies the ID of the IP address group.
ip_list	Array of IpInfo objects	Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address.
listeners	Array of ListenerRef objects	Lists the IDs of listeners with which the IP address group is associated.
name	String	Specifies the IP address group name.
project_id	String	Specifies the project ID of the IP address group.
updated_at	String	Specifies the time when the IP address group was updated.

**Table 8** IpInfo
Parameter	Type	Description
ip	String	Specifies the IP addresses in the IP address group. IPv6 is unsupported. Please do not enter IPv6 addresses.
description	String	Provides remarks about the IP address group. Minimum: 0 Maximum: 255

**Table 9** ListenerRef
Parameter	Type	Description
id	String	Specifies the listener ID.

Example Requests

Creating an IP address group

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

Status Codes

Status Code	Description
201	Normal response to POST requests.

Error Codes

See Error Codes.

Parent topic: IP Address Group

20 KiB Raw Blame History