文档首页/ 云数据库 RDS/ API参考/ API v3/ 备份与恢复/ 修改备份空间告警配置 - UpdateBackupUsageAlarmConfig
更新时间：2026-11-02 GMT+08:00
查看PDF
分享

修改备份空间告警配置 - UpdateBackupUsageAlarmConfig

功能介绍

修改备份空间告警配置，包括告警开关、阈值百分比和增量百分比。关闭告警时不需要传阈值和增量参数。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:backup:updateBackupUsageAlarmConfig

write

-

-

-

-

接口约束

该接口仅支持RDS for MySQL。

URI

  • URI格式

    PUT /v3/{project_id}/backups/usage-alarm-config

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释：

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求消息

表2 参数说明

参数

是否必选

参数类型

描述

alarm_enabled

是

String

参数解释：

告警开关。

约束限制：

不涉及。

取值范围：

  • ON：开关开启。
  • OFF：开关关闭。

默认取值：

不涉及。

threshold_percent

否

Integer

参数解释：

阈值百分比，占免费备份空间大小的百分比。

约束限制：

不涉及。

取值范围：

1~100

默认取值：

90

increment_percent

否

Integer

参数解释：

增量百分比，占免费备份空间大小的百分比。

约束限制：

不涉及。

取值范围：

1~100

默认取值：

10

请求示例

打开备份空间告警配置。

PUT https://{endpoint}/v3/04d4856ce8c0272c0e2fc0b4db90e5b4/backups/usage-alarm-config

{
   "alarm_enabled" : "ON",
   "threshold_percent" : 90,
   "increment_percent" : 10
}

响应消息

  • 正常响应要素说明
    表3 参数说明

    参数

    参数类型

    描述

    status

    String

    参数解释：

    操作执行状态。

    取值范围：

    COMPLETED：执行完成。
  • 正常响应样例 
    {
   "status" : "COMPLETED"
}

状态码

错误码

请参见错误码。

父主题： 备份与恢复

相关文档