Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Querying the Reference Table List
Updated on 2024-04-25 GMT+08:00

Querying the Reference Table List

Function

This API is used to query the reference table list.

URI

GET /v1/{project_id}/waf/valuelist

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page

No

Integer

Page number of the data to be returned during pagination query. The default value is 1, indicating that the data on the first page is returned.

pagesize

No

Integer

Number of results on each page during pagination query. Value range: 1 to 100. The default value is 10, indicating that each page contains 10 results.

name

No

String

Reference table name

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 (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Number of reference tables

items

Array of ValueListResponseBody objects

Reference table list

Table 5 ValueListResponseBody

Parameter

Type

Description

id

String

ID of the reference table

name

String

Reference table name.

type

String

Reference table type

Enumeration values:

  • url

  • params

  • ip

  • cookie

  • referer

  • user-agent

  • header

  • response_code

  • response_header

  • response_body

timestamp

Long

Reference table timestamp

values

Array of strings

Value of the reference table

producer

Integer

Reference table source. The value can be 1 or others. 1: The table is created by you. Other values indicate that the table is automatically generated by moduleX.

description

String

Reference table description

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Requests

The following example shows how to query the reference table list in a project. The project ID is specified by project_id.

GET https://{Endpoint}/v1/{project_id}/waf/valuelist?enterprise_project_id=0

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "items" : [ {
    "id" : "3b03be27a40b45d3b21fe28a351e2021",
    "name" : "ip_list848",
    "type" : "ip",
    "values" : [ "100.100.100.125" ],
    "timestamp" : 1650421866870,
    "producer" : 1,
    "description" : "demo"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.