调用CreateAndStartBackupPlan接口,创建、配置备份计划并启动。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateAndStartBackupPlan

系统规定参数。取值:CreateAndStartBackupPlan

BackupMethod String logical

备份方式,取值:

  • logical:逻辑备份
  • physical:物理备份
  • duplication:转储备份
BackupPlanName String dbstooi0*******

备份计划名称。

DatabaseType String MySQL

数据库类型,取值:

  • MySQL
  • MSSQL
  • Oracle
  • MariaDB
  • PostgreSQL
  • PPAS
  • DRDS
  • MongoDB
  • Redis
  • File
InstanceClass String micro

备份计划的规格,取值:

  • micro
  • small
  • medium
  • large
  • xlarge
说明 规格越高,备份与恢复的性能越高,更多信息,请参见 规格说明
SourceEndpointInstanceType String RDS

数据库所在位置,取值:

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

备份计划ID。

Region String cn-hangzhou

DBS地域,取值:

  • cn-hangzhou:公有云杭州
  • cn-shanghai:公有云上海
  • cn-qingdao:公有云青岛
  • cn-beijing:公有云北京
  • cn-shenzhen:公有云深圳
  • cn-hongkong:公有云中国香港
  • ap-southeat-1:公有云新加坡
  • cn-hangzhou-finance:金融云杭州
  • cn-shanghai-finance:金融云上海
  • cn-shenzhen-finance:金融云深圳
Period String Year

指定预付费实例为包年或者包月类型,取值:

  • Year:包年
  • Month:包月
UsedTime Integer 1

指定购买时长,取值:

  • 当参数PeriodYear时,UsedTime取值为1~9
  • 当参数PeriodMonth时,UsedTime取值为1~11
PayType String Postpaid

支付方式,取值:

  • Postpaid:后付费(按量付费)
  • prepay:预付费(包年包月)
说明 默认prepay,目前只有 BackupMethodduplication时支持 postpay
DatabaseRegion String cn-hangzhou

数据库地域。

说明PayTypepostpay时,该参数必选。
StorageRegion String cn-hangzhou

存储地域。

说明PayTypepostpay时,该参数必选。
InstanceType String RDS

数据库实例类型,取值:

  • RDS
  • PolarDB
  • DDS
  • Kvstore
  • Other
    说明PayTypepostpay时,必选。
StorageType String

该参数暂未开放使用。

FromApp String OpenApi

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

SourceEndpointRegion String cn-hangzhou

数据库地域。

说明 SourceEndpoint. InstanceTypeRDSECSDDSExpressAgent时,该参数必传。
SourceEndpointInstanceID String rm-uf6wjk5xxxxxxxxxx

数据库实例ID。

说明 SourceEndpoint. InstanceTypeRDSECSDDSExpress时,该参数必传。
SourceEndpointIP String rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com

数据库连接地址。

说明 SourceEndpoint. InstanceTypeexpressagentother时,该参数必传。
SourceEndpointPort Integer 3306

数据库端口。

说明 SourceEndpoint. InstanceTypeexpressagentotherECS时,该参数必传。
SourceEndpointDatabaseName String testRDS

数据库名称。

说明 数据库类型为 PostgreSQLMongoDB时,该参数必传。
SourceEndpointUserName String testRDS

数据库账号。

说明 数据库类型为 Redis,或者数据库所在位置为 agent且数据库类型为 MSSQL时该参数非必须,其他场景均必传。
SourceEndpointPassword String testPassword

密码。

说明 数据库类型为 Redis,或者数据库所在位置为 agent且数据库类型为 MSSQL时该参数非必须,其他场景均必传。
BackupGatewayId Long 23313123312

备份网关ID。

说明 SourceEndpoint. InstanceTypeagent时,该参数必传。
OSSBucketName String TestOssBucket

OSS Bucket名称。

默认:系统自动生成新的名称。

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

备份对象。

BackupPeriod String Monday

全量备份周期,取值:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
BackupStartTime String 14:22

全量备份开始时间,格式为HH:mmZ(UTC时间)。

EnableBackupLog Boolean true

是否开启增量日志备份,取值:

  • true:开启
  • false:关闭
BackupLogIntervalSeconds Integer 1000

增量时间间隔,以秒为单位。

说明 只支持物理备份。
BackupRetentionPeriod Integer 730

备份数据保留时间,取值:0-1825,默认为730。

DuplicationInfrequentAccessPeriod Integer 180

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

DuplicationArchivePeriod Integer 365

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

SourceEndpointOracleSID String test

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

BackupStorageType String

内置存储类型:

  • 默认空:备份数据存储在用户OSS上。
  • system :备份数据存储在DBS的内置OSS上。
BackupSpeedLimit Long 262144

磁盘IO限制 , 单位为KB/S。

说明 仅对MySQL物理备份生效。
BackupRateLimit Long 262144

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

说明 仅对MySQL物理备份生效。
BackupStrategyType String simple

全量备份周期,取值:

  • simple:周期备份,和BackupPeriod、BackupStartTime配合使用。
  • manual:手动备份。
说明 默认为 simple
CrossAliyunId String 2xxx7778xxxxxxxxxx

跨阿里云账号备份的uid。

CrossRoleName String test123

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

RegionId String cn-hangzhou

地域ID,您可以调用DescribeRegions查询。

ClientToken String DBS

任意字符串。

返回数据

名称 类型 示例值 描述
BackupPlanId String dbs1hvb0wwweusfa

备份计划ID。

ErrCode String Param.NotFound

错误码。

ErrMessage String The specified parameter %s value is not valid.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

OrderId String 2056157***

订单ID。

RequestId String 4F1888AC-1138-4995-B9FE-D2734F61C058

请求ID。

Success Boolean true

是否请求成功。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateAndStartBackupPlan
&BackupMethod=logical
&BackupPlanName=dbstooi0*******
&DatabaseType=MySQL
&InstanceClass=micro
&SourceEndpointInstanceType=RDS
&<公共请求参数>

正常返回示例

XML格式

<CreateAndStartBackupPlanResponse>
      <RequestId>3321E2F6-98E3-4B81-ADEC-9FD1BC06249A</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <BackupPlanId>dbs1hrlzt68t7ko1</BackupPlanId>
      <OrderId>208422747270728</OrderId>
      <Success>true</Success>
</CreateAndStartBackupPlanResponse>

JSON格式

{
	"RequestId": "3321E2F6-98E3-4B81-ADEC-9FD1BC06249A",
	"HttpStatusCode": 200,
	"BackupPlanId": "dbs1hrlzt68t7ko1",
	"OrderId": 208422747270728,
	"Success": true
}

错误码

访问错误中心查看更多错误码。