文档首页/ 数据库安全服务 DBSS/ API参考/ API/ SQL白名单功能/ 查询白名单列表
更新时间：2025-09-10 GMT+08:00
查看PDF
分享

查询白名单列表

功能介绍

查询白名单列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

instance_id

是

String

参数解释：

实例ID。可通过查询实例列表接口ID字段获取

约束限制：

不涉及

取值范围：

以查询实例列表接口值为准，字符长度32-64。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

分页偏移量，从第一条数据偏移offset条数据后开始查询

约束限制：

仅支持大于等于0的整数

取值范围：

大于等于0

默认取值：

默认值为0

limit

否

Integer

参数解释：

每页查询记录数。

约束限制：

仅支持大于0的整数

取值范围：

大于0小于等于10000

默认取值：

默认值为100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总条数

whitelists

Array of WhitelistBean objects

白名单列表
表5 WhitelistBean

参数

参数类型

描述

create_timestamp_ms

Long

创建时间

db_ids

Array of strings

数据库IDs

desc

String

描述

enabled

Boolean

状态

  • true:启用

  • false: 禁用

id

String

记录ID

sql

String

SQL语句

update_timestamp_ms

Long

更新时间

状态码：400

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：401

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表12 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息
表13 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

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

响应示例

状态码：200

OK

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

状态码

状态码

描述

200

OK

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题： SQL白名单功能