Querying a Blacklist or Whitelist

Function

This API is used to query a blacklist or whitelist.

URI

GET /v1/{project_id}/black-white-lists

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
object_id	Yes	String	Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If the value of type is 0, the protected object ID belongs to the Internet border. If the value of type is 1, the protected object ID belongs to the VPC border. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).
list_type	Yes	Integer	Blacklist/Whitelist type: 4 (blacklist), 5 (whitelist).
address_type	No	Integer	IP address type: 0 (IPv4), 1 (IPv6).
address	No	String	IP address
port	No	String	Port
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.
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.

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	Return value for querying the blacklist/whitelist.

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	Query the total number of blacklist/whitelist records.
records	Array of records objects	Blacklist/Whitelist.

Table 6 records

Parameter	Type	Description
list_id	String	Blacklist/Whitelist ID.
direction	Integer	Direction of a blacklist/whitelist address: 0 (source address), 1 (destination address).
address_type	Integer	IP address type: 0 (IPv4), 1 (IPv6).
address	String	IP address
protocol	Integer	Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic).
port	String	Port
description	String	Description.

Status code: 400

Table 7 Response body parameters

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

Example Requests

Query five whitelist records on the first page of object cfebd347-b655-4b84-b938-3c54317599b2 in project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5

Example Responses

Status code: 200

Return value of a blacklist or whitelist query.

{
  "data" : {
    "limit" : 10,
    "offset" : 0,
    "records" : [ {
      "address" : "1.1.1.1",
      "address_type" : 0,
      "description" : "",
      "direction" : 0,
      "list_id" : "1310d401-daf5-44f2-8276-f79e1643984d",
      "protocol" : 6
    } ],
    "total" : 1
  }
}

Status code: 400

Bad Request

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

Status Codes

Status Code	Description
200	Return value of a blacklist or whitelist query.
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