Updated on 2024-10-11 GMT+08:00

Querying IP Address Groups

Function

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

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

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

Table 1 Path Parameters

Parameter

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 returned 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 is used to filter the IP address group. Multiple IDs can be specified for filtering.

name

No

Array of strings

IP address group name, which is used to filter the IP address group. Multiple names can be specified for filtering.

ip_version

No

Integer

  • IP address version, which is used to filter the IP address group.

  • Value range: 4, 6.

description

No

Array of strings

Supplementary information about an IP address group, which is used to filter the IP address group. Multiple descriptions can be specified for filtering.

enterprise_project_id

No

String

  • Enterprise project ID, which is used to filter the IP address groups of an enterprise project.

  • The project ID can be 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, specify all_granted_eps.

Maximum: 36

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

address_groups

Array of AddressGroup objects

Response body for querying 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 no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

description

String

  • Description about the IP address group.

  • The value can contain no more than 255 characters.

  • The value cannot contain angle brackets (< or >).

max_capacity

Integer

  • Maximum number of entries in an IP address group. Each entry can be an IP address, IP address range, or CIDR block.

  • The value can be from 0 to 20.

  • The default value is 20.

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 one of the following:

    • 4 (IPv4 address groups).

    • 6 (IPv6 address groups).

created_at

String

  • Time when the IP address group was created.

  • The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss, which is automatically generated by the system.

updated_at

String

  • Time when the IP address group was last updated.

  • The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss, which is automatically generated by the system.

tenant_id

String

  • ID of the project where the IP address group is used.

enterprise_project_id

String

  • Enterprise project ID.

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

Maximum: 36

tags

Array of ResourceTag objects

  • IP address group tags.

status

String

  • IP address group status.

  • The value can be one of the following:

    • NORMAL: The IP address group is normal.

    • UPDATING: The IP address group is being updated.

    • UPDATE_FAILED: Updating the IP address group failed.

  • The default value is NORMAL.

  • An IP address group in the UPDATING status cannot be updated again.

status_message

String

  • Details of the IP address group status.

ip_extra_set

Array of IpExtraSetRespOption objects

  • IP address sets and their remarks in an IP address group.

Table 5 ResourceTag

Parameter

Type

Description

key

String

  • Tag key

  • Tag keys must be unique for each resource.

Minimum: 1

Maximum: 128

value

String

  • Tag value.

Maximum: 255

Table 6 IpExtraSetRespOption

Parameter

Type

Description

ip

String

  • An IP address, IP address range, or CIDR block. Both IPv4 and IPv6 are supported.

remarks

String

  • Supplementary information about the IP address, IP address range, or CIDR block.

  • The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

Table 7 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 Requests

Query address groups based on combined filter criteria.

GET https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups?name=vkvgykvsvhjaaaa1&description=xxxxxxxxxx&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" : "AutoTester746010.580123789",
        "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" : ""
      } ],
      "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.