Querying Address Group Members

Function

This API is used to query members in an address group.

URI

GET /v1/{project_id}/address-items

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
set_id	Yes	String	Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).
key_word	No	String	Keyword, including the name or part of the description of an address group member.
limit	Yes	Integer	Number of records displayed on each page. The value ranges from 1 to 1024.
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
enterprise_project_id	No	String	Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.
fw_instance_id	No	String	Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.
query_address_set_type	No	Integer	Type of the address group to be queried: 0 (user-defined address group), 1 (predefined address group).

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by referring to Obtaining a User Token.
Content-Type	Yes	String	Content type. It can only be set to application/json.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
data	data object	Returned data for querying address group members.

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. The value ranges from 1 to 1024.
total	Integer	Total number of address group members.
set_id	String	Address group ID.
records	Array of records objects	List of address group member records.

Table 6 records

Parameter	Type	Description
item_id	String	ID of an address group member.
name	String	Name of an address group member.
description	String	Description.
address_type	Integer	Address type: 0 (IPv4), 1 (IPv6).
address	String	Address information.

Status code: 400

Table 7 Response body parameters

Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

Query members in the address group 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0

Example Responses

Status code: 200

Return value for querying address group members.

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "records" : [ {
      "address" : "1.1.1.1",
      "address_type" : 0,
      "description" : "",
      "item_id" : "294fab71-34bf-4858-a380-8f7530e1c816"
    } ],
    "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
    "total" : 1
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200005",
  "error_msg" : "Object not found."
}

Status Codes

Status Code	Description
200	Return value for querying address group members.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

last updated: 2025-01-21 13:19 UTC - commit: abe94c6df6d30c3b44340c2119ffd81f9990504a