接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rds:DescribeBackupTasks | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 |
用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。 |
ETnLKlblzczshOTUbOCz**** |
| Flag | string | 否 |
备用参数。 |
无 |
| DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
| BackupJobId | integer | 否 |
备份任务ID。 |
476**** |
| BackupMode | string | 否 |
备份模式，取值：
|
Automated |
| BackupJobStatus | string | 否 |
备份任务状态，取值：
默认为所有状态。 |
NoStart |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
返回参数详情。 |
||
| RequestId | string |
请求ID。 |
90496720-2319-42A8-87CD-FCE4DF95EBED |
| Items | object [] |
备份任务列表。 |
|
| Process | string |
任务进度百分比。 |
25 |
| BackupJobId | string |
备份任务ID。 |
476**** |
| BackupStatus | string |
备份任务状态。取值：
说明 | NoStart |
| JobMode | string | 备份模式，取值：
|
Automated |
| BackupProgressStatus | string |
备份程序状态。取值：
|
NoStart |
| BackupId | string |
任务生成的备份集ID。 说明 | 34665**** |
| TaskAction | string | 任务类型，取值：
|
NormalBackupTask |
示例
正常返回示例
JSON格式
{
"RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED",
"Items": {
"BackupJob": [
{
"Process": "25",
"BackupJobId": "476****",
"BackupStatus": "NoStart",
"JobMode": "Automated",
"BackupProgressStatus": "NoStart",
"BackupId": "34665****",
"TaskAction": "NormalBackupTask"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InternalFailure | Internal failure, retry later. | 请求失败，请稍后重试。 |
| 400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | 操作失败，参数OwnerAccount不合法，请检查。 |
| 400 | ReadDBInstanceNotSupport | The operation is not permitted due to type of the instance. | 只读实例不允许执行该操作。 |
| 400 | InvalidParameters.Format | Specified parameter is not valid | 操作失败，指定的参数格式不合法。 |
| 404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | 数据库实例ID不存在，请检查。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的实例不存在指定的实例被删除或者实例不支持当前操作。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/156522.html