Querying IP Address Groups

Function

This API is used to query IP address groups.

Constraints

This API has the following constraints:

Parameters marker, limit, and page_reverse are used for pagination query.
Parameters marker and page_reverse take effect only when they are used together with parameter limit.

Calling Method

For details, see Calling APIs.

URI

GET /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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Definition: Specifies the ID of the last record on the previous page. Constraints: This parameter must be used together with limit. If the parameter is not specified, only resources on the first page are queried. This parameter cannot be left blank or set to an invalid ID. Range: N/A Default value: N/A
limit	No	Integer	Definition: Specifies the number of records returned on each page. Constraints: N/A Range: 0 to 2000 Default value: 2000
page_reverse	No	Boolean	Definition: Specifies whether to use reverse query. Constraints: This parameter must be used together with limit. If page_reverse is set to true and you want to query the resources on the previous page, set the value of marker to the value of previous_marker. Range: true: Query resources on the previous page. false: Query resources on the next page. Default value: false
id	No	Array of strings	Definition: Specifies the ID of an IP address group. Constraints: N/A Range: N/A Default value: N/A
name	No	Array of strings	Definition: Specifies the name of an IP address group. Constraints: N/A Range: N/A Default value: N/A
description	No	Array of strings	Definition: Provides supplementary information about an IP address group. Constraints: N/A Range: N/A Default value: N/A
ip_list	No	Array of strings	Definition: Specifies one or more IP entries for querying IP address groups. If you enter multiple IP entries, the system searches for all IP address groups containing any of the IP entries. Note: All IP addresses, CIDR blocks, and IP address ranges are searched using exact matches. For example, if an IP address group has the IP address range 127.0.0.1-127.0.0.10, you need to set ip_list to 127.0.0.1-127.0.0.10. Constraints: N/A Range: N/A Default value: N/A
enterprise_project_id	No	Array of strings	Definition: Specifies the ID of the enterprise project. Multiple values can be used for query in the format of: enterprise_project_id=xxx&enterprise_project_id=xxx. Constraints: If enterprise_project_id is not specified, resources in all enterprise projects are queried by default. Fine-grained authorization is performed. The elb:ipgroups:list permission must be assigned to the user group. If enterprise_project_id is specified, the value can be a specific enterprise project ID or all_granted_eps. If the value is a specific enterprise project ID, only resources in the enterprise project are queried. If the value is all_granted_eps, resources in the enterprise projects with the elb:ipgroups:list permission are queried. Range: N/A Default value: N/A

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
ipgroups	Array of IpGroup objects	Definition: Lists the returned IP address groups.
request_id	String	Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).
page_info	PageInfo object	Definition: Specifies the pagination information.

**Table 5** 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 6** 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 7** ListenerRef
Parameter	Type	Description
id	String	Definition: Specifies the listener ID. Range: N/A

**Table 8** PageInfo
Parameter	Type	Description
previous_marker	String	Definition: Specifies the ID of the first record in the pagination query result. If page_reverse is set to true, this parameter is used together to query resources on the previous page. Range: N/A
next_marker	String	Definition: Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Range: N/A
current_count	Integer	Definition: Specifies the number of records returned on the current page. Range: N/A

Example Requests

Querying IP address groups on each page

GET https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups?limit=1

Example Responses

Status code: 200

Successful request.

{
  "ipgroups" : [ {
    "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"
  } ],
  "page_info" : {
    "previous_marker" : "1d321f77-bc7b-45d3-9cfe-d7c0b65a3620",
    "current_count" : 1
  },
  "request_id" : "8d9f423c-8766-4b6a-9952-275a88ac1ce3"
}