Help Center/ Cloud Firewall/ API Reference/ API/ Address Group Management/ Querying IP Address Groups
Updated on 2023-12-06 GMT+08:00
View PDF

Querying IP Address Groups

Function

Querying IP Address Groups

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/address-sets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

object_id

Yes

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

key_word

No

String

Keyword

limit

Yes

Integer

Number of records displayed on each page

offset

Yes

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

address

No

String

IP address

address_type

No

Integer

Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6).

Enumeration values:

  • 0

  • 1

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

No

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

Data returned for the address group list query
Table 5 data

Parameter

Type

Description

offset

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

limit

Integer

Number of records displayed on each page

total

Integer

Total

records

Array of records objects

IP address group list
Table 6 records

Parameter

Type

Description

set_id

String

ID of the IP address group

ref_count

Integer

Reference count

description

String

Description

name

String

IP address group name

address_type

Integer

Address type. The value can be 0 (IPv4) or 1 (IPv6).

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum: 8

Maximum: 36

error_msg

String

Description

Minimum: 2

Maximum: 512

Example Requests

This API is used to query the IP address group information on the first page of project 8a41d6a5-f215-428a-a76c-dc923b5d599a. The protected object ID is 5c69cf330cda42369cbd726ee1bc5e76.

https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0

Example Responses

Status code: 200

OK

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "records" : [ {
      "address_type" : 0,
      "description" : "",
      "name" : "ceshi",
      "ref_count" : 0,
      "set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b"
    } ],
    "total" : 1
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.0020016",
  "error_msg" : "instance status error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Address Group Management