文档首页/数据库安全服务 DBSS/API参考/API说明/备份管理/获取备份配置信息 - SetAuditAutoBackupTemplate
更新时间：2026-01-22 GMT+08:00
查看PDF
分享

获取备份配置信息 - SetAuditAutoBackupTemplate

功能介绍

设置备份配置信息

URI

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

表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参数

参数

参数类型

描述

bucket_name

String

OBS桶名称

bucket_root_path

String

OBS备份根路径

cycle

String

周期

  • PER_DAY：每天

  • PER_WEEK：每周

  • PER_MONTH：每月

  • PER_HOUR：每小时

  • FIVE_MIN：每5分钟

latest_backup_time

String

最近备份时间

status

Integer

备份开关

  • 0：关闭

  • 1：开启

trigger_time

String

触发时间

triggered

Boolean

是否已触发

状态码：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/template

响应示例

状态码：200

OK

{
  "cycle" : "PER_HOUR",
  "trigger_time" : "2025-08-21 02:15:44",
  "triggered" : false,
  "latest_backup_time" : null,
  "status" : 1,
  "bucket_name" : "cbh-ynf",
  "bucket_root_path" : "/dbss"
}

状态码

状态码

描述

200

OK

400

请求参数有误

401

认证失败

403

未授权

500

服务端错误

错误码

请参见错误码。

父主题：备份管理