ConfigureBackupPlan_数据灾备_API调试-阿里云OpenAPI开发者门户

请求参数

字段名称	字段详情
BackupPlanIdstring	备份计划 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。示例值:dbstooi0*******参考取值来源: StopBackupPlan UpgradeBackupPlan RenewBackupPlan StartBackupPlan CreateBackupPlan ReleaseBackupPlan ModifyBackupPlanName EnableBackupLog DescribeBackupPlanList DisableBackupLog
SourceEndpointInstanceTypestring	数据库所在位置，可通过调用 DescribeBackupPlanList 接口获取该参数的值。取值如下：展开详情示例值:RDS
SourceEndpointRegionstring	数据库地域，可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情示例值:cn-hangzhou
SourceEndpointInstanceIDstring	数据库实例 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情示例值:rm-uf6wjk5*********参考取值来源: DescribeRestoreRangeInfo
SourceEndpointIPstring	数据库连接地址，可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情示例值:rm-uf6wjk5*******.mysql.rds.aliyuncs.com参考取值来源: DescribeRestoreRangeInfo
SourceEndpointPortinteger<int32>	数据库端口，可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情示例值:3306
SourceEndpointDatabaseNamestring	数据库名称，可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情示例值:testRDS
SourceEndpointUserNamestring	数据库账号。展开详情示例值:testRDS
SourceEndpointPasswordstring	密码。展开详情示例值:testPassword
BackupGatewayIdinteger<int64>	备份网关 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:23313123312参考取值来源: DescribeBackupGatewayList
OSSBucketNamestring	OSS Bucket 名称。展开详情示例值:TestOssBucket参考取值来源: DescribeBackupPlanList
BackupObjectsstring	备份对象，可通过调用 DescribeBackupPlanList 接口获取该参数的值。示例值:[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]参考取值来源: DescribeBackupPlanList
BackupPeriodstring	全量备份周期，取值：展开详情示例值:Monday
BackupStartTimestring	全量备份开始时间，格式为HH:mmZ（UTC 时间）。可通过调用 DescribeBackupPlanList 接口获取该参数的值。示例值:14:22
EnableBackupLogboolean	是否开启增量日志备份，取值：展开详情示例值:true
BackupLogIntervalSecondsinteger<int32>	增量时间间隔，以秒（s）为单位。展开详情示例值:1000
BackupRetentionPeriodinteger<int32>	备份数据保留时间，取值：0 ~ 1825，默认为 730 天。示例值:730
DuplicationInfrequentAccessPeriodinteger<int32>	转为低频访问存储时间，默认为 180 天。示例值:180
DuplicationArchivePeriodinteger<int32>	转为归档冷备存储时间，默认为 365 天。示例值:365
BackupPlanNamestring	自定义备份计划名称，可通过调用 DescribeBackupPlanList 接口获取该参数的值。示例值:dbstooi0*******参考取值来源: CreateAndStartBackupPlan DescribeBackupPlanList
SourceEndpointOracleSIDstring	Oracle SID 名称。展开详情示例值:test参考取值来源: DescribeBackupPlanList
BackupStorageTypestring	内置存储类型：展开详情示例值:无参考取值来源: DescribeBackupPlanList
BackupSpeedLimitinteger<int64>	磁盘 IO 限制，单位为 KB/s。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:262144
BackupRateLimitinteger<int64>	网络带宽限制，单位为 KB/s ，最大允许 10GB。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:262144
BackupStrategyTypestring	全量备份周期，取值：展开详情示例值:simple
CrossAliyunIdstring	跨阿里云账号备份的 UID，可通过调用 DescribeRestoreTaskList 接口获取该参数的值。示例值:2xxx7778xxxxxxxxxx
CrossRoleNamestring	跨阿里云账号备份的 RAM 角色名称，可通过调用 DescribeRestoreTaskList 接口获取该参数的值。示例值:test123
AutoStartBackupboolean	是否开启自动备份。展开详情示例值:false
ClientTokenstring	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。示例值:ETnLKlblzczshOTUbOCzxxxxxxx
ResourceGroupIdstring	资源组 ID。示例值:rg-aekzecovzti****

返回参数

字段名称	字段详情
HttpStatusCodeinteger<int32>	HTTP 状态码。示例值:200
RequestIdstring	请求 ID。示例值:F1FB49D4-B504-47F1-9F43-D7EAB33F****
ErrCodestring	错误码。示例值:Param.NotFound
Successboolean	请求是否成功，返回值如下：展开详情示例值:true
ErrMessagestring	错误信息。示例值:The specified parameter %s value is not valid.
BackupPlanIdstring	备份计划 ID。示例值:dbstooi01ex****

变更历史

	变更时间	变更内容概要	操作
	2022-07-28	新增请求参数ResourceGroupId