Querying a Reference Table¶

Function¶

This API is used to query a reference table.

URI¶

GET /v1/{project_id}/waf/valuelist/{valuelist_id}

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
valuelist_id	Yes	String	Valuelist ID. It can be obtained by calling the API Querying the Reference Table List

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token
Content-Type	No	String	Content type Default: application/json;charset=utf8

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
id	String	ID of a reference table
name	String	Reference table name
type	String	The value can be: url params ip cookie referer user-agent header response_code response_header response_body
timestamp	String	Reference table timestamp
values	Array of strings	Value of the reference table
description	String	Reference table description
producer	Integer	This parameter is reserved and can be ignored currently. Enumeration values: 1

Status code: 400

**Table 4** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 5** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 6** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests¶

GET https://{Endpoint}/v1/{project_id}/waf/valuelist/{table_id}?

Example Responses¶

Status code: 200

Request succeeded.

{
  "id" : "3978ca9403844a62bbd24bb5b8d16d4e",
  "name" : "demo2",
  "type" : "url",
  "values" : [ "/demo" ],
  "timestamp" : 1656495488880,
  "description" : "",
  "producer" : 1
}

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.

last updated: 2024-07-08 01:32