CreateAndStartBackupPlan - 创建并启动备份计划

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:CreateAndStartBackupPlanWrite
  • DBS
    acs:dbs:{#regionId}:{#accountId}:backupplan/*

请求参数

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

备份计划ID。

dbstooi0*******
Regionstring

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:金融云深圳
cn-hangzhou
InstanceClassstring

备份计划的规格,取值:

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

数据库类型,取值:

  • MySQL
  • MSSQL
  • Oracle
  • MariaDB
  • PostgreSQL
  • PPAS
  • DRDS
  • MongoDB
  • Redis
  • File
MySQL
BackupMethodstring

备份方式,取值:

  • logical:逻辑备份
  • physical:物理备份
  • duplication:转储备份
logical
Periodstring

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

  • Year:包年
  • Month:包月
Year
UsedTimeinteger

指定购买时长,取值:

  • 当参数PeriodYear时,UsedTime取值为1~9。
  • 当参数PeriodMonth时,UsedTime取值为1~11。
1
PayTypestring

支付方式,取值:

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

数据库地域。

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

存储地域。

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

数据库实例类型,取值:

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

该参数暂未开放使用。

FromAppstring

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

OpenApi
SourceEndpointInstanceTypestring

数据库所在位置,取值:

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

数据库地域。

说明SourceEndpoint.InstanceTypeRDSECSDDSExpressAgent时,该参数必传。
cn-hangzhou
SourceEndpointInstanceIDstring

数据库实例ID。

说明SourceEndpoint.InstanceTypeRDSECSDDSExpress时,该参数必传。
rm-uf6wjk5xxxxxxxxxx
SourceEndpointIPstring

数据库连接地址。

说明SourceEndpoint.InstanceTypeexpressagentother时,该参数必传。
rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
SourceEndpointPortinteger

数据库端口。

说明SourceEndpoint.InstanceTypeexpressagentotherECS时,该参数必传。
3306
SourceEndpointDatabaseNamestring

数据库名称。

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

数据库账号。

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

密码。

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

备份网关ID。

说明SourceEndpoint.InstanceTypeagent时,该参数必传。
23313123312
OSSBucketNamestring

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

TestOssBucket
BackupObjectsstring

备份对象。

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

全量备份周期,取值:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
说明支持选择多个取值,用英文逗号(,)分开。
Monday
BackupStartTimestring

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

14:22
EnableBackupLogboolean

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

  • true:开启
  • false:关闭
true
BackupLogIntervalSecondsinteger

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

说明仅支持物理备份
1000
BackupRetentionPeriodinteger

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

730
DuplicationInfrequentAccessPeriodinteger

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

180
DuplicationArchivePeriodinteger

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

365
BackupPlanNamestring

自定义备份计划名称。

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。

2xxx7778xxxxxxxxxx
CrossRoleNamestring

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

test123
ClientTokenstring

任意字符串。

DBS
ResourceGroupIdstring

资源组ID。

rg-aekzecovzti****

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP状态码。

200
RequestIdstring

请求ID。

4F1888AC-1138-4995-B9FE-D2734F61C058
CreateBackupSetboolean

是否开启备份集,返回值如下:

  • true:开启
  • false:关闭
true
ErrCodestring

错误码。

Param.NotFound
Successboolean

是否请求成功。

true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
BackupPlanIdstring

备份计划ID。

dbs1hvb0wwweusfa
OrderIdstring

订单ID。

2056157***

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=CreateAndStartBackupPlan
&BackupMethod=logical
&BackupPlanName=dbstooi0*******
&DatabaseType=MySQL
&InstanceClass=micro
&SourceEndpointInstanceType=RDS
&<公共请求参数>

正常返回示例

JSON格式

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

XML格式

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

错误码

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

阿里云首页 数据库备份 DBS 相关技术圈