调用ConfigureBackupPlan接口，配置一个DBS备份计划。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dbs:ConfigureBackupPlan | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BackupPlanId | string | 是 | 备份计划ID，可通过调用DescribeBackupPlanList接口获取该参数的值。 | dbstooi0******* |
| SourceEndpointInstanceType | string | 是 | 数据库所在位置，可通过调用DescribeBackupPlanList接口获取该参数的值。取值如下：
| RDS |
| SourceEndpointRegion | string | 否 | 数据库地域，可通过调用DescribeBackupPlanList接口获取该参数的值。 说明SourceEndpointInstanceType为RDS、ECS、DDS、Express、Agent时，该参数必传。 | cn-hangzhou |
| SourceEndpointInstanceID | string | 否 | 数据库实例ID，可通过调用DescribeBackupPlanList接口获取该参数的值。 说明SourceEndpoint.InstanceType为RDS、ECS、DDS、Express时，该参数必传。 | rm-uf6wjk5********* |
| SourceEndpointIP | string | 否 | 数据库连接地址，可通过调用DescribeBackupPlanList接口获取该参数的值。 说明SourceEndpointInstanceType为express、agent、other时，该参数必传。 | rm-uf6wjk5*******.mysql.rds.aliyuncs.com |
| SourceEndpointPort | integer | 否 | 数据库端口，可通过调用DescribeBackupPlanList接口获取该参数的值。 说明SourceEndpoint.InstanceType为express、agent、other、ECS时，该参数必传。 | 3306 |
| SourceEndpointDatabaseName | string | 否 | 数据库名称，可通过调用DescribeBackupPlanList接口获取该参数的值。 说明数据库类型为PostgreSQL、MongoDB时，该参数必传。 | testRDS |
| SourceEndpointUserName | string | 否 | 数据库账号。 说明数据库类型为Redis，或者数据库所在位置为agent且数据库类型为SQL Server时该参数非必须，其他场景均必传。 | testRDS |
| SourceEndpointPassword | string | 否 | 密码。 说明数据库类型为Redis，或者数据库所在位置为agent且数据库类型为SQL Server时该参数非必须，其他场景均必传。 | testPassword |
| BackupGatewayId | long | 否 | 备份网关ID，可通过调用DescribeBackupPlanList接口获取该参数的值。 说明SourceEndpointInstanceType为agent时，该参数必传。 | 23313123312 |
| OSSBucketName | string | 否 | OSS Bucket名称。 说明系统默认自动生成新的名称。 | TestOssBucket |
| BackupObjects | string | 否 | 备份对象，可通过调用DescribeBackupPlanList接口获取该参数的值。 | [ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ] |
| BackupPeriod | string | 否 | 全量备份周期，取值：
| Monday |
| BackupStartTime | string | 否 | 全量备份开始时间，格式为HH:mmZ（UTC时间）。可通过调用DescribeBackupPlanList接口获取该参数的值。 | 14:22 |
| EnableBackupLog | boolean | 否 | 是否开启增量日志备份，取值：
| true |
| BackupLogIntervalSeconds | integer | 否 | 增量时间间隔，以秒（s）为单位。 说明仅支持物理备份。 | 1000 |
| BackupRetentionPeriod | integer | 否 | 备份数据保留时间，取值：0 ~ 1825，默认为730天。 | 730 |
| DuplicationInfrequentAccessPeriod | integer | 否 | 转为低频访问存储时间，默认为180天。 | 180 |
| DuplicationArchivePeriod | integer | 否 | 转为归档冷备存储时间，默认为365天。 | 365 |
| BackupPlanName | string | 是 | 自定义备份计划名称，可通过调用DescribeBackupPlanList接口获取该参数的值。 | dbstooi0******* |
| SourceEndpointOracleSID | string | 否 | Oracle SID名称。 说明数据库类型为Oracle时，该参数必传。 | test |
| BackupStorageType | string | 否 | 内置存储类型：
| 无 |
| BackupSpeedLimit | long | 否 | 磁盘IO限制 ， 单位为KB/s。 说明仅对MySQL物理备份生效。 | 262144 |
| BackupRateLimit | long | 否 | 网络带宽限制， 单位为KB/s ，最大允许10GB。 说明仅对MySQL物理备份生效。 | 262144 |
| BackupStrategyType | string | 否 | 全量备份周期，取值：
说明默认为simple。 | simple |
| CrossAliyunId | string | 否 | 跨阿里云账号备份的UID，可通过调用DescribeRestoreTaskList接口获取该参数的值。 | 2xxx7778xxxxxxxxxx |
| CrossRoleName | string | 否 | 跨阿里云账号备份的RAM角色名称，可通过调用DescribeRestoreTaskList接口获取该参数的值。 | test123 |
| AutoStartBackup | boolean | 否 | 是否开启自动备份。
| false |
| ClientToken | string | 否 | 用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。 | ETnLKlblzczshOTUbOCzxxxxxxx |
| ResourceGroupId | string | 否 | 资源组ID。 | rg-aekzecovzti**** |
返回参数
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"BackupPlanId": "dbstooi01ex****"
}错误码
访问错误中心查看更多错误码。