Updated on 2025-09-10 GMT+08:00

Querying Whitelists

Function

Querying whitelists

URI

GET /v1/{project_id}/audit/{instance_id}/whitelists

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

Constraints

N/A

Range:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. The value can be obtained from the ID field of the API for querying the instance list.

Constraints

N/A

Range:

The value is subject to the value of the API for querying the instance list. The value contains 32 to 64 characters.

Default Value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition:

Pagination offset. The query starts after the offset of the first data record.

Constraints

Only integers greater than or equal to 0 are supported.

Range:

Greater than or equal to 0

Default Value:

The default value is 0.

limit

No

Integer

Definition:

Number of records queried on each page.

Constraints

Only integers greater than 0 are supported.

Range:

Greater than 0 and less than or equal to 10000

Default Value:

The default value is 100.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Constraints

N/A

Range:

The value is subject to the user token query interface of the IAM service.

Default Value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total records.

whitelists

Array of WhitelistBean objects

Whitelist

Table 5 WhitelistBean

Parameter

Type

Description

create_timestamp_ms

Long

Creation time.

db_ids

Array of strings

Database IDs.

desc

String

Description

enabled

Boolean

Status.

  • true: enabled

  • false: disabled

id

String

Record ID.

sql

String

SQL statement.

update_timestamp_ms

Long

Update time.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 7 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 9 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 11 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 13 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v1/{project_id}/audit/{instance_id}/whitelists

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "whitelists" : [ {
    "id" : "JM1JypgBOOXTipG9cwk_",
    "sql" : "select",
    "desc" : "",
    "db_ids" : [ ],
    "enabled" : true,
    "create_timestamp_ms" : 1755740468029,
    "update_timestamp_ms" : 1755740468029
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.