ConfigureBackupPlan - 配置备份计划

调用ConfigureBackupPlan接口，配置一个DBS备份计划。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
BackupPlanIdstring是

备份计划ID，可通过调用DescribeBackupPlanList接口获取该参数的值。

dbstooi0*******
SourceEndpointInstanceTypestring是

数据库所在位置，可通过调用DescribeBackupPlanList接口获取该参数的值。取值如下：

  • RDS
  • ECS
  • Express：通过专线/VPN网关/智能网关接入的数据库
  • Agent：通过备份网关接入的数据库
  • DDS：云MongoDB
  • Other：通过IP:Port直连的数据库
RDS
SourceEndpointRegionstring否

数据库地域，可通过调用DescribeBackupPlanList接口获取该参数的值。

说明SourceEndpointInstanceType为RDS、ECS、DDS、Express、Agent时，该参数必传。
cn-hangzhou
SourceEndpointInstanceIDstring否

数据库实例ID，可通过调用DescribeBackupPlanList接口获取该参数的值。

说明SourceEndpoint.InstanceType为RDS、ECS、DDS、Express时，该参数必传。
rm-uf6wjk5*********
SourceEndpointIPstring否

数据库连接地址，可通过调用DescribeBackupPlanList接口获取该参数的值。

说明SourceEndpointInstanceType为express、agent、other时，该参数必传。
rm-uf6wjk5*******.mysql.rds.aliyuncs.com
SourceEndpointPortinteger否

数据库端口，可通过调用DescribeBackupPlanList接口获取该参数的值。

说明SourceEndpoint.InstanceType为express、agent、other、ECS时，该参数必传。
3306
SourceEndpointDatabaseNamestring否

数据库名称，可通过调用DescribeBackupPlanList接口获取该参数的值。

说明数据库类型为PostgreSQL、MongoDB时，该参数必传。
testRDS
SourceEndpointUserNamestring否

数据库账号。

说明数据库类型为Redis，或者数据库所在位置为agent且数据库类型为SQL Server时该参数非必须，其他场景均必传。
testRDS
SourceEndpointPasswordstring否

密码。

说明数据库类型为Redis，或者数据库所在位置为agent且数据库类型为SQL Server时该参数非必须，其他场景均必传。
testPassword
BackupGatewayIdLong否

备份网关ID，可通过调用DescribeBackupPlanList接口获取该参数的值。

说明SourceEndpointInstanceType为agent时，该参数必传。
23313123312
OSSBucketNamestring否

OSS Bucket名称。

说明系统默认自动生成新的名称。
TestOssBucket
BackupObjectsstring否

备份对象，可通过调用DescribeBackupPlanList接口获取该参数的值。

[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
BackupPeriodstring否

全量备份周期，取值：

  • Monday：周一
  • Tuesday：周二
  • Wednesday：周三
  • Thursday：周四
  • Friday：周五
  • Saturday：周六
  • Sunday：周日
Monday
BackupStartTimestring否

全量备份开始时间，格式为HH:mmZ（UTC时间）。可通过调用DescribeBackupPlanList接口获取该参数的值。

14:22
EnableBackupLogboolean否

是否开启增量日志备份，取值：

  • true：开启
  • false：关闭
true
BackupLogIntervalSecondsinteger否

增量时间间隔，以秒（s）为单位。

说明仅支持物理备份。
1000
BackupRetentionPeriodinteger否

备份数据保留时间，取值：0 ~ 1825，默认为730天。

730
DuplicationInfrequentAccessPeriodinteger否

转为低频访问存储时间，默认为180天。

180
DuplicationArchivePeriodinteger否

转为归档冷备存储时间，默认为365天。

365
BackupPlanNamestring是

自定义备份计划名称，可通过调用DescribeBackupPlanList接口获取该参数的值。

dbstooi0*******
SourceEndpointOracleSIDstring否

Oracle SID名称。

说明数据库类型为Oracle时，该参数必传。
test
BackupStorageTypestring否

内置存储类型：

  • 空（默认）：备份数据存储在用户OSS上。
  • system ：备份数据存储在DBS的内置OSS上。
无
BackupSpeedLimitLong否

磁盘IO限制 ， 单位为KB/s。

说明仅对MySQL物理备份生效。
262144
BackupRateLimitLong否

网络带宽限制， 单位为KB/s ，最大允许10GB。

说明仅对MySQL物理备份生效。
262144
BackupStrategyTypestring否

全量备份周期，取值：

  • simple：周期备份，和BackupPeriod、BackupStartTime配合使用。
  • manual：手动备份。
说明默认为simple。
simple
CrossAliyunIdstring否

跨阿里云账号备份的UID，可通过调用DescribeRestoreTaskList接口获取该参数的值。

2xxx7778xxxxxxxxxx
CrossRoleNamestring否

跨阿里云账号备份的RAM角色名称，可通过调用DescribeRestoreTaskList接口获取该参数的值。

test123
AutoStartBackupboolean否

是否开启自动备份。

  • true：开启
  • false：不开启
false
ClientTokenstring否

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

ETnLKlblzczshOTUbOCzxxxxxxx

返回参数

名称类型描述示例值
object

详情信息如下。

HttpStatusCodeinteger

HTTP状态码。

200
RequestIdstring

请求ID。

F1FB49D4-B504-47F1-9F43-D7EAB33F****
ErrCodestring

错误码。

Param.NotFound
Successboolean

请求是否成功，返回值如下：

  • true：请求成功
  • false：请求失败
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
BackupPlanIdstring

备份计划ID。

dbstooi01ex****

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ConfigureBackupPlan
&BackupPlanId=dbstooi0*******
&SourceEndpointInstanceType=RDS
&BackupPlanName=dbstooi0*******
&公共请求参数

正常返回示例

JSON格式

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "HttpStatusCode": 200,
  "BackupPlanId": "dbstooi01ex****",
  "Success": true
}

XML格式

<ConfigureBackupPlanResponse>
    <RequestId>D6E068C3-25BC-455A-85FE-45F0B22E****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <BackupPlanId>dbstooi01ex****</BackupPlanId>
    <Success>true</Success>
</ConfigureBackupPlanResponse>

错误码

访问错误中心查看更多错误码。
阿里云首页 数据库备份 DBS 相关技术圈