文档首页/数据库安全服务 DBSS/API参考/API说明/风险导出/获取单个风险导出配置 - ShowAuditBackRiskTemplate
更新时间：2026-01-22 GMT+08:00
查看PDF
分享

获取单个风险导出配置 - ShowAuditBackRiskTemplate

功能介绍

获取单个风险导出配置

URI

GET /v1/{project_id}/audit/{instance_id}/backup/risk/template/{db_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

instance_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

db_id

是

String

参数解释：

数据库ID。可通过获取风险导出配置列表db_id字段获取。

约束限制：

不涉及

取值范围：

以获取风险导出配置列表接口值为准，字符长度16-64。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

db_id

String

数据库ID

db_ip

String

数据库IP

db_name

String

数据库名称

db_port

Integer

数据库端口

id

String

配置ID

status

Integer

状态

  • 0：关闭

  • 1：开启

状态码：400

表4 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表5 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：401

表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错误信息

状态码：403

表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错误信息

状态码：500

表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错误信息

请求示例

/v1/{project_id}/audit/{instance_id}/backup/risk/template/{db_id}

响应示例

状态码：200

OK

{
  "id" : "_QS6ypgBhN3UjKKcnymn",
  "status" : 1,
  "db_id" : "twS8v5gBhN3UjKKcoyJ6",
  "db_ip" : "10.0.2.3",
  "db_name" : "pgtest",
  "db_port" : 5300
}

状态码

状态码

描述

200

OK

400

请求参数有误

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题：风险导出