文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 报表管理/ 获取报表模板
更新时间：2025-09-10 GMT+08:00
查看PDF
分享

获取报表模板

功能介绍

获取报表模板

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/audit/{instance_id}/reports/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

instance_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

os_type

String

os类型

templates

Array of TemplateInfo objects

模板列表
表4 TemplateInfo

参数

参数类型

描述

template

TemplateBean object

模板对象
表5 TemplateBean

参数

参数类型

描述

db_ids

String

数据库ID

db_names

String

数据库名称

desc

String

描述

frequency

String

周期

group

String

类型

  • COMPREHENSIVE: 综合报表

  • COMPLIANCE: 合规报表

  • DB_SPECIAL：数据库专项报表

  • CLIENT_SPECIAL：客户端专项报表

  • SQL_SPECIAL：SQL

id

String

模板ID

name

String

报表模板名称

status

String

状态

  • OFF：已关闭

  • ON：已开启

type

String

报表类型

  • COMPREHENSIVE: 数据库安全综合报表

  • COMPLIANCE: 数据库安全合规报表

  • SOX: SOX-萨班斯报表

  • PCI: 行业标准安全报表

  • DB_ANALYSIS: 数据库服务器分析报表

  • CLIENT_IP_ANALYSIS: 客户端IP分析报表

  • SQL_DCL_COMMAND: DCL命令报表

  • SQL_DDL_COMMAND: DDL命令报表

  • SQL_DML_COMMAND: DML命令报表

状态码：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错误信息

请求示例

/v2/{project_id}/audit/{instance_id}/reports/templates

响应示例

状态码：200

OK

{
  "templates" : [ {
    "template" : {
      "id" : "t8g7LJgBTpKZyZbbeTgS",
      "name" : "数据库安全综合报表",
      "type" : "COMPREHENSIVE",
      "group" : "COMPREHENSIVE",
      "frequency" : "AUDIT_REPORT_WEEK",
      "status" : "ON",
      "desc" : "数据库安全综合报表",
      "db_ids" : "",
      "db_names" : ""
    }
  } ],
  "os_type" : "amd64"
}

状态码

状态码

描述

200

OK

400

请求参数有误。

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题： 报表管理

相关文档