Help Center/ Edge Security/ API Reference/ API/ Reference Table Management/ Creating a Reference Table
Updated on 2024-11-18 GMT+08:00
View PDF
Share

Creating a Reference Table

Function

This API is used to create a reference table.

URI

POST /v1/edgesec/configuration/http/reference-table

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

auth token
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Reference table name

type

Yes

String

Reference table type. The value can be url, params, ip, cookie, referer, user-agent, header, response_code, response_header or response_body.

values

Yes

Array of strings

Value of the reference table

description

No

String

Reference table description. The value contains a maximum of 128 characters.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

ID of the referenced table

name

String

Reference table name

type

String

Reference table type

description

String

Reference table description

timestamp

Long

Reference table timestamp

values

Array of strings

Value of the reference table

producer

Integer

Source

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Standard error code: service name.8-digit code

error_msg

String

Detailed error information.

encoded_authorization_message

String

If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Standard error code: service name.8-digit code

error_msg

String

Detailed error information.

encoded_authorization_message

String

If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Standard error code: service name.8-digit code

error_msg

String

Detailed error information.

encoded_authorization_message

String

If the service is integrated with IAM5.0, an IAM response must be returned when access is denied.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.