Querying IP Address Groups

Function

This API is used to query IP address groups based on filter criteria.

URI

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

**Table 1** Parameter description
Name	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records displayed on each page. Value range: 0 to 2000
marker	No	String	Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.
id	No	Array of strings	Unique ID of an IP address group, which can be used to filter the IP address group.
name	No	Array of strings	Name of an IP address group, which can be used to filter the IP address group.
ip_version	No	Integer	Version of IP addresses in an IP address group. The value can be 4 or 6.
description	No	Array of strings	Provides supplementary information about an IP address group, which can be used to filter the IP address group.

Request Parameter

None

Example Request

Query IP address groups based on combined filtering criteria

"GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&ip_version=4"

Response Parameter

When the status code is 200, the response parameters are as follows:

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Request ID
address_groups	Array of AddressGroup objects	Response body of IP address groups
page_info	PageInfo object	Pagination information

**Table 4** 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 up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
description	String	Provides supplementary information about an IP address group. The value can contain up to 255 characters. The value cannot contain angle brackets (< or >).
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: 4: IPv4 address group. 6: IPv6 address group.
created_at	String	Time (UTC) when the IP address group is created. The value must be the UTC time in the format of yyyy-MM-ddTHH:mmss.
updated_at	String	Time (UTC) when the IP address group was last updated. The value must be the UTC time in the format of yyyy-MM-ddTHH:mmss.
tenant_id	String	ID of the project to which the IP address group belongs.

**Table 5** PageInfo
Parameter	Type	Description
previous_marker	String	First record on the current page
current_count	Integer	Total number of records on the current page
next_marker	String	Last record on the current page. This parameter does not exist if the page is the last one.

Example Response

When the status code is 200, the response parameters are as follows:

Normal response for the GET operation of the API for querying an IP address group

{
    "address_groups": [
        {
            "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
            "name": "AutoTester746010.580123789", 
            "tenant_id": "b2782e6708b8475c993e6064bc456bf8", 
            "ip_version": 4, 
            "ip_set": [
                "192.168.5.0/24", 
                "192.168.3.20-192.168.3.100",  
                "192.168.3.40", 
                "192.168.3.2"
            ], 
            "created_at": "2019-06-28T02:06:38", 
            "updated_at": "2019-06-28T02:06:38", 
            "description": "test"
        }
    ], 
    "page_info": {
        "previous_marker": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
        "current_count": 1
    }, 
    "request_id": "e51fa17c-3259-4122-afb1-9c03d4ef5408"
}