# 开启/关闭备份 - SetAuditBackupSwitch #### 功能介绍 开启/关闭备份 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DBSS/doc?api=SetAuditBackupSwitch)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dbss/dbss_01_0428.html)。 #### URI POST /v1/{domain_id}/audit/{instance_id}/backup/switch 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 账户ID。 通过调用IAM服务\[查询IAM用户详情\]接口获取 **约束限制**： 不涉及 **取值范围**： 以IAM服务\[查询IAM用户详情\]接口值为准。 **默认取值**： 不涉及 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过查询实例列表接口ID字段获取 **约束限制**： 不涉及 **取值范围**： 以查询实例列表接口值为准，字符长度32-64。 **默认取值**： 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及 **取值范围**： IAM服务查询用户Token接口为准 **默认取值**： 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bucket_name | 是 | String | OBS桶名称 | | bucket_root_path | 否 | String | 备份根路径 | | cycle | 是 | String | 备份周期 - PER_DAY：每天 - PER_WEEK：每周 - PER_MONTH：每月 - PER_HOUR：每小时 - FIVE_MIN：每5分钟 | | mode | 是 | String | 备份模式 - AUTO：自动备份 | | status | 是 | Integer | 开关状态 - 0：关闭 - 1：开启 | | trigger_time | 是 | String | 触发时间，yyyy-MM-dd HH:mm:ss | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | 操作结果 - SUCCESS：成功 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表6DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表8DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表10DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | **状态码：500** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | details | Array of [DbssErrorDetail] objects | PDP5鉴权异常信息 | | encoded_authorization_message | String | PDP5鉴权异常信息 | | error_code | String | 错误码 | | error_msg | String | 错误信息 | 表12DbssErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | PDP5错误信息 | #### 请求示例 ``` /v1/{domain_id}/audit/{instance_id}/backup/switch { "mode" : "AUTO", "trigger_time" : "2025-08-21 02:00:44", "status" : 1, "cycle" : "PER_HOUR", "bucket_name" : "cbh-ynf", "bucket_root_path" : "" } ``` #### 响应示例 **状态码：200** OK ``` { "result" : "SUCCESS" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | 请求参数有误 | | 401 | 认证失败 | | 403 | 未授权 | | 500 | 服务端错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dbss/ErrorCode.html)。