CreateAndStartBackupPlan
该接口用于创建、配置并启动备份计划
服务地址：
华东1 金融云
输入参数
只看必填
BackupPlanId
RegionDBS支持地域
InstanceClass备份计划的规格
DatabaseType数据库类型
BackupMethod备份方式
Period指定预付费实例为包年或者包月类型
UsedTime指定购买时长
PayType支付方式
DatabaseRegion数据库地域
StorageRegion存储地域
InstanceType数据库实例类型
StorageType该参数暂未开放使用
FromApp用于备注请求来源
SourceEndpointInstanceType数据库所在位置
SourceEndpointRegion数据库地域
SourceEndpointInstanceID数据库实例ID
SourceEndpointIP数据库连接地址
SourceEndpointPort数据库端口
SourceEndpointDatabaseName数据库名称
SourceEndpointUserName数据库账号
SourceEndpointPassword密码
BackupGatewayId备份网关ID
OSSBucketNameOSS Bucket名称
BackupObjects备份对象
BackupPeriod全量备份周期
BackupStartTime全量备份开始时间
EnableBackupLog是否开启增量日志备份
请选择布尔值
BackupLogIntervalSeconds增量时间间隔
BackupRetentionPeriod备份数据保留时间
DuplicationInfrequentAccessPeriod转为低频访问存储时间
DuplicationArchivePeriod转为归档冷备存储时间
BackupPlanName自定义备份计划名称
SourceEndpointOracleSIDOracle SID名称
BackupStorageType内置存储类型：
BackupSpeedLimit磁盘IO限制
BackupRateLimit网络带宽限制
BackupStrategyType全量备份周期
CrossAliyunId跨阿里云账号备份的UID
CrossRoleName跨阿里云账号备份的RAM角色名称
ResourceGroupId资源组ID
幂等性参数
ClientToken用于保证请求的幂等性
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

请确保在使用该接口前，已充分了解数据库备份 DBS 产品的收费方式和价格。

请求参数

字段名称字段详情
BackupPlanIdstring

备份计划 ID。

示例值:dbstooi0*******参考取值来源:
    StopBackupPlan
    UpgradeBackupPlan
    StartBackupPlan
    RenewBackupPlan
    CreateBackupPlan
    ReleaseBackupPlan
    ModifyBackupPlanName
    EnableBackupLog
    ConfigureBackupPlan
    DescribeBackupPlanList
    DisableBackupLog
Regionstring

DBS 支持地域，可调用 DescribeRegions 接口查看。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
InstanceClassstring

备份计划的规格，取值：展开详情

示例值:micro
DatabaseTypestring

数据库类型，取值：展开详情

示例值:MySQL
BackupMethodstring

备份方式，取值：展开详情

示例值:logical参考取值来源:
    CreateBackupPlan
    DescribeBackupPlanList
Periodstring

指定预付费实例为包年或者包月类型，取值：展开详情

示例值:Year
UsedTimeinteger<int32>

指定购买时长，取值：展开详情

示例值:1
PayTypestring

支付方式，取值：展开详情

示例值:postpay
DatabaseRegionstring

数据库地域。展开详情

示例值:cn-hangzhou
StorageRegionstring

存储地域。展开详情

示例值:cn-hangzhou
InstanceTypestring

数据库实例类型，取值：展开详情

示例值:RDS
StorageTypestring

该参数暂未开放使用。

示例值:无
FromAppstring

用于备注请求来源，默认值为 OpenApi，无需手动设置。

示例值:OpenApi
SourceEndpointInstanceTypestring

数据库所在位置，取值：展开详情

示例值:RDS
SourceEndpointRegionstring

数据库地域。展开详情

示例值:cn-hangzhou
SourceEndpointInstanceIDstring

数据库实例 ID。展开详情

示例值:rm-uf6wjk5xxxxxxxxxx参考取值来源:
    DescribeRestoreRangeInfo
SourceEndpointIPstring

数据库连接地址。展开详情

示例值:rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com参考取值来源:
    DescribeRestoreRangeInfo
SourceEndpointPortinteger<int32>

数据库端口。展开详情

示例值:3306
SourceEndpointDatabaseNamestring

数据库名称。展开详情

示例值:testRDS
SourceEndpointUserNamestring

数据库账号。展开详情

示例值:testRDS
SourceEndpointPasswordstring

密码。展开详情

示例值:testPassword
BackupGatewayIdinteger<int64>

备份网关 ID。展开详情

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:23313123312参考取值来源:
    DescribeBackupGatewayList
OSSBucketNamestring

OSS Bucket 名称。展开详情

示例值:TestOssBucket参考取值来源:
    DescribeBackupPlanList
BackupObjectsstring

备份对象。

示例值:[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]参考取值来源:
    DescribeBackupPlanList
BackupPeriodstring

全量备份周期，取值：展开详情

示例值:Monday
BackupStartTimestring

全量备份开始时间，格式为HH:mm（UTC 时间）。

示例值:14:22
EnableBackupLogboolean

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

示例值:true
BackupLogIntervalSecondsinteger<int32>

增量时间间隔，以秒（s）为单位。展开详情

示例值:1000
BackupRetentionPeriodinteger<int32>

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

示例值:730
DuplicationInfrequentAccessPeriodinteger<int32>

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

示例值:180
DuplicationArchivePeriodinteger<int32>

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

示例值:365
BackupPlanNamestring

自定义备份计划名称。

示例值:dbstooi0*******参考取值来源:
    DescribeBackupPlanList
SourceEndpointOracleSIDstring

Oracle SID 名称，数据库类型为 Oracle 时，该参数必传。

示例值:test参考取值来源:
    DescribeBackupPlanList
BackupStorageTypestring

内置存储类型：展开详情

示例值:无参考取值来源:
    DescribeBackupPlanList
BackupSpeedLimitinteger<int64>

磁盘 IO 限制， 单位为 KB/s。展开详情

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:262144
BackupRateLimitinteger<int64>

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

注意 该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。
示例值:262144
BackupStrategyTypestring

全量备份周期，取值：展开详情

示例值:simple
CrossAliyunIdstring

跨阿里云账号备份的 UID。

示例值:1648821913******
CrossRoleNamestring

跨阿里云账号备份的 RAM 角色名称。

示例值:test123
ClientTokenstring

用于保证请求的幂等性，防止重复提交请求。

示例值:ASDASDASDSADASFCZXVZ
ResourceGroupIdstring

资源组 ID。

示例值:rg-aekzecovzti****

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

HTTP 状态码。

示例值:200
RequestIdstring

请求 ID。

示例值:4F1888AC-1138-4995-B9FE-D2734F61C058
CreateBackupSetboolean

是否开启备份集，返回值如下：展开详情

示例值:true
ErrCodestring

错误码。

示例值:Param.NotFound
Successboolean

是否请求成功。

示例值:true
ErrMessagestring

错误信息。

示例值:The specified parameter %s value is not valid.
BackupPlanIdstring

备份计划 ID。

示例值:dbs1hvb0wwwe****
OrderIdstring

订单 ID。

示例值:2056157***
变更历史
变更时间变更内容概要操作
2022-07-28
新增请求参数ResourceGroupId