为PolarDB集群创建全量快照备份。
接口说明
说明
每个集群最多可以同时存在 3 个手动创建的备份。
若出现错误提示
调用该接口后,会在后台创建备份任务,若数据量较大,花费的时间可能较长,请耐心等待。
Exceeding the daily backup times of this DB cluster
,表明您的集群中已存在 3 个手动创建的备份,请删除备份后再使用该接口。调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:CreateBackup | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 | pc-************* |
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。 | 6000170000591aed949d0f54a343f1a4233c1e7d1c5c****** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F3322AFE-083E-4D77-A074-421301******",
"BackupJobId": "11111111"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidBackupType.Malformed | The specified parameter BackupType is not valid. | 指定的参数BackupType无效。 |
400 | InvalidBackupMethod.Malformed | The specified parameter BackupMethod is not valid. | 指定的参数BackupMethod无效。 |
403 | BackupTimesExceeded | The maximum number of backups per day is exceeded. | 操作失败,已超过集群每日备份次数上限(上限:3次)。 |
404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-09-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-03-25 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2022-03-25 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|