Help Center/ Virtual Private Cloud/ API Reference (Ally Region)/ VPC APIs (V3)/ IP Address Group/ Querying IP Address Groups
Updated on 2026-01-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying IP Address Groups

Function

This API is used to query information about all IP address groups, including the IP address group name and IP addresses.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

ID of the project that an IP address group belongs to.

Range:

N/A.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition:

Number of resources on each page.

Range:

0 to 2000

marker

No

String

Definition:

Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried.

Range:

ID of an IP address group.

id

No

Array of strings

Definition:

ID of an IP address group. This field can be used to precisely filter IP address groups. Multiple IDs can be specified for filtering.

Range:

N/A

name

No

Array of strings

Definition:

The name of an IP address group. This field can be used to precisely filter IP address groups. Multiple names can be specified for filtering.

Range:

N/A

ip_version

No

Integer

Definition:

IP address version of an IP address group. This field can be used to filter IP address groups.

Range:

  • 4: IPv4 address groups will be filtered.

  • 6: IPv6 address groups will be filtered.

description

No

Array of strings

Definition:

Description about an IP address group. This field can be used to precisely filter IP address groups. Multiple descriptions can be specified for filtering.

Range:

N/A

enterprise_project_id

No

String

Definition:

ID of the enterprise project that an IP address group belongs to. This field can be used to filter the IP address groups of an enterprise project.

Range:

  • The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.

  • To obtain the IP address groups associated with all enterprise projects that a user has permissions to view, specify all_granted_eps.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Definition:

Request ID.

Range:

N/A

address_groups

Array of AddressGroup objects

Definition:

Response body for querying IP address groups.

Range:

N/A

page_info

PageInfo object

Definition:

Pagination information.

Range:

N/A
Table 4 AddressGroup

Parameter

Type

Description

id

String

Definition:

ID of an IP address group. After an IP address group is created, an IP address group ID is generated, which uniquely identifies the IP address group.

Range:

The value is in UUID format with hyphens (-).

name

String

Definition:

The name of an IP address group.

Range:

The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods.

description

String

Definition:

Description about an IP address group.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

ip_set

Array of strings

Definition:

IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported.

Range:

An IP address entry in an IP address set can be:

  • A single IP address, for example, 192.168.21.25

  • An IP address range, for example, 192.168.21.25-192.168.21.30

  • A CIDR block, for example, 192.168.21.0/24

ip_version

Integer

Definition:

IP address version of an IP address group.

Range:

  • 4: IPv4 address group

  • 6: IPv6 address group

created_at

String

Definition:

Time when an IP address group was created.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.

updated_at

String

Definition:

Time when an IP address group was last updated.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.

tenant_id

String

Definition:

ID of the project that an IP address group belongs to.

Range:

N/A

enterprise_project_id

String

Definition:

ID of the enterprise project that an IP address group belongs to.

Range:

The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.

ip_extra_set

Array of IpExtraSetRespOption objects

Definition:

IP address entries in an IP address group and their remarks.

Range:

N/A
Table 5 ResponseTag

Parameter

Type

Description

key

String

Definition:

Tag key.

Range:

  • A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.

  • Each tag key of a resource must be unique.

  • The value can contain:

    • Letters

    • Digits

    • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

value

String

Definition:

Tag value.

Range:

  • Each value can contain a maximum of 255 Unicode characters and can be left blank.

  • The value can contain:

    • Letters

    • Digits

    • Special characters: underscores (_), colons (:), plus signs (+), hyphens (-), and equal signs (=)
Table 6 IpExtraSetRespOption

Parameter

Type

Description

ip

String

Definition:

IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported.

Range:

  • A single IP address, for example, 192.168.21.25

  • An IP address range, for example, 192.168.21.25-192.168.21.30

  • A CIDR block, for example, 192.168.21.0/24

remarks

String

Definition:

Remarks of an IP address entry.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).
Table 7 PageInfo

Parameter

Type

Description

previous_marker

String

Definition:

The first record on the current page.

Range:

N/A

current_count

Integer

Definition:

Total number of resources on the current page.

Range:

N/A

next_marker

String

Definition:

The last record on the current page. The next_marker field does not exist if the page is the last one.

Range:

N/A

Example Requests

Query IP address groups based on combined filters.

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

Example Responses

Status code: 200

Normal response to the GET operation. For more status codes, see Status Codes.

{
  "address_groups" : [ {
    "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
    "name" : "ipGroup-test",
    "tenant_id" : "b2782e6708b8475c993e6064bc456bf8",
    "ip_version" : 4,
    "max_capacity" : 20,
    "ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ],
    "ip_extra_set" : [ {
      "ip" : "192.168.5.0/24",
      "remarks" : null
    }, {
      "ip" : "192.168.3.20-192.168.3.100",
      "remarks" : null
    }, {
      "ip" : "192.168.3.40",
      "remarks" : null
    }, {
      "ip" : "192.168.3.2",
      "remarks" : null
    } ],
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "created_at" : "2019-06-28T02:06:38.000+00:00",
    "updated_at" : "2019-06-28T02:06:38.000+00:00",
    "description" : "test",
    "status" : "NORMAL",
    "status_message" : "",
    "tags" : [ ]
  } ],
  "page_info" : {
    "previous_marker" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
    "current_count" : 1
  },
  "request_id" : "e51fa17c-3259-4122-afb1-9c03d4ef5408"
}

Status Codes

Status Code

Description

200

Normal response to the GET operation. For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent topic: IP Address Group