文档首页/ 数据安全中心 DSC/ API参考/ API/ 安全策略管理/ 查询数据库审计实例信息 - ShowDbssInsInfo
更新时间:2026-11-13 GMT+08:00
分享

查询数据库审计实例信息 - ShowDbssInsInfo

功能介绍

功能介绍:查询数据库审计(DBSS)实例信息,返回实例ID、名称及审计状态,供配置安全策略时选择。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/security-policies/dbss-info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

owner_account_id

否

String

参数解释:

归属账号ID,标识实例所属的租户账号,可通过查询账号列表接口或在控制台获取归属账号ID

约束限制:

不涉及

取值范围:

满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

dbss_instance_info_list

Array of DbssInstanceInfo objects

参数解释:

DBSS实例信息列表,数组中的每个元素为DbssInstanceInfo对象,包含实例ID、实例名称等信息

取值范围:

不涉及

dbss_rds_database_list

Array of RdsDatabase objects

参数解释:

RDS数据库列表,数组中的每个元素为RdsDatabase对象,包含资源ID、数据库名称、数据库类型、是否已配置等信息

取值范围:

不涉及

表5 DbssInstanceInfo

参数

参数类型

描述

instance_id

String

参数解释:

实例标识

取值范围:

不涉及

instance_name

String

参数解释:

实例名称

取值范围:

不涉及

表6 RdsDatabase

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

db_name

String

参数解释:

数据库名称

取值范围:

不涉及

type

String

参数解释:

数据库类型

取值范围:

  • GDE-数据库加密

  • GDE_DECRYPT-数据库加密解密

  • DOM-数据库运维

  • DBSS-数据库安全服务

  • DDM-数据库动态脱敏

  • SDM-数据库静态脱敏

configured

Boolean

参数解释:

是否已配置

取值范围:

true-是,false-否

请求示例

无

响应示例

状态码:200

{
  "dbss_rds_database_list" : [ {
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "db_name" : "customer_db",
    "type" : "GDE",
    "configured" : true
  } ],
  "dbss_instance_info_list" : [ {
    "instance_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "instance_name" : "dbss-instance-01"
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档