Help Center/ Cloud Firewall/ API Reference (Ankara Region)/ API/ Blacklist and Whitelist Management/ Querying a Blacklist or Whitelist
Updated on 2024-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Blacklist or Whitelist

Function

This API is used to query a blacklist or whitelist.

Calling Method

For details, see Calling APIs.

URI

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

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

Internet border Protected object ID, 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.

list_type

Yes

Integer

Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist).

Enumeration values:

  • 4

  • 5

address_type

No

Integer

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

Enumeration values:

  • 0

  • 1

  • 2

address

No

String

IP address

port

No

String

Port

limit

Yes

Integer

Number of records displayed on each page, in the range 1-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, 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

Return value for querying the blacklist or 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, in the range 1-1024

total

Integer

Total number of queried records

records

Array of records objects

Blacklist and whitelist records
Table 6 records

Parameter

Type

Description

list_id

String

Blacklist/Whitelist ID

direction

Integer

Direction of a black or white 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. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

port

String

Port

description

String

description

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

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" : "instance status error"
}

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.