文档

PurgeDBInstanceLog - 清理或收缩RDS实例日志

更新时间:

该接口用于清理RDS实例的本地日志。

接口说明

适用引擎

  • RDS MySQL
  • RDS SQL Server

功能说明

RDS 实例有自动上传日志备份机制,但是在实例空间不足时,您可以使用本接口手动上传日志备份,提前释放存储空间。上传后系统会自动清理本地重复的日志备份。 调用本接口会将本地日志备份上传到 OSS 上(SQL Server 会先收缩事务日志再上传),然后清理本地日志备份,释放存储空间。

注意事项

  • 上传日志备份不会影响数据恢复功能。
  • 释放的是存储空间,不是备份空间,因此不会降低备份空间使用量。
  • 日志备份上传到的 OSS 由 RDS 提供,不需要您购买,同时也不支持访问此 OSS。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:PurgeDBInstanceLogWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

待清理或收缩日志的实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

65BDA532-28AF-4122-AA39-B382721EEE64

示例

正常返回示例

JSON格式

{
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

错误码

HTTP status code错误码错误信息描述
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败,实例处于锁定状态。
403ConcurrentTaskExceededConcurrent task exceeding the allowed amount.并发任务超出数量。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectDBInstanceCharacterTypeCurrent DB Instance character_type does not support this operation.当前DB实例字符类型不支持此操作。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InvalidPage.NotFoundPage not found.指定参数未找到,请检查确认参数。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:403
  • 本页导读 (1)
文档反馈