Querying IP Address Groups

Function

This API is used to query IP address groups.

Calling Method

For details, see Calling APIs.

URI

GET /v1/ip-groups

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of resources on each page. If this parameter is not specified, the default value is 500.
marker	No	String	Specifies the ID of the resource from which pagination query starts, that is, the ID of the last resource on the previous page. If the parameter is not specified, only resources on the first page are queried. This parameter must be used together with limit.
listener_id	No	String	Specifies the listener ID that is used to query the associated IP address group. If listener_id is specified, only the IP address group associated with the specified listener is returned.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
ip_groups	Array of IpGroupDetail objects	Specifies the details of the IP address group.
page_info	PageInfo object	Specifies the pagination query information.

**Table 4** IpGroupDetail
Parameter	Type	Description
id	String	Specifies the ID of the IP address group.
name	String	Specifies the name of the IP address group.
description	String	Describes the IP address group.
status	String	Specifies the provisioning status. The value can be one of the following: ACTIVE: The resource is running. PENDING: The status is to be determined. ERROR: Failed to create the resource. DELETING: The resource is being deleted.
ip_list	Array of IpInfo objects	Specifies the CIDR blocks in the IP address group.
associated_listeners	Array of ListenerAccessControlPolicy objects	Specifies the access control policy used by the listener.
created_at	String	Specifies the time when the resource was created.
updated_at	String	Specifies the time when the resource was updated.

**Table 5** IpInfo
Parameter	Type	Description
cidr	String	Specifies the CIDR block in the IP address group.
description	String	Describes the CIDR block in the IP address group.
created_at	String	Specifies the time when the resource was created.

**Table 6** ListenerAccessControlPolicy
Parameter	Type	Description
listener_id	String	Specifies the listener ID.
type	String	Specifies the access control policy type. The value can be one of the following: BLACK: blacklist WHITE: whitelist

**Table 7** PageInfo
Parameter	Type	Description
next_marker	String	Specifies the marker of the next page. If this parameter is left empty, the resource is on the last page.
current_count	Integer	Specifies the number of resources on the current list.

Example Requests

Querying IP address groups

GET https://{ga_endpoint}/v1/ip-groups

Example Responses

Status code: 200

Operation successful.

{
  "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8",
  "ip_groups" : [ {
    "id" : "e8996cd6-28cf-4ff2-951e-fa8ac895a6cd",
    "name" : "ip-group-name",
    "description" : "ip-group description",
    "status" : "ACTIVE",
    "ip_list" : [ {
      "cidr" : "127.0.0.0/24",
      "description" : "cidr description",
      "created_at" : "2019-01-08T01:21:37.151Z"
    } ],
    "associated_listeners" : [ {
      "listener_id" : "1b11747a-b139-492f-9692-2df0b1c87193",
      "type" : "BLACK"
    } ],
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z"
  } ],
  "page_info" : {
    "next_marker" : "09e86f09-03fc-440e-8132-03f3e149e979",
    "current_count" : 10
  }
}