CreateBackupPlan - 创建备份计划

调用CreateBackupPlan接口,创建一个DBS备份计划。

接口说明

本接口对应的控制台操作,请参见购买备份计划

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
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:包月
Month
UsedTimeinteger

指定购买时长,取值如下:

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

支付方式,取值如下:

  • postpay:后付费(按量付费)
  • prepay:预付费(包年包月)
说明默认为prepay。当BackupMethodduplication支持postpay方式。
prepay
DatabaseRegionstring

数据库地域。

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

存储地域。

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

数据库实例类型,取值如下:

  • RDS
  • PolarDB
  • DDS
  • Kvstore
  • Other:通过IP:Port直接输入。
说明PayTypepostpay时,此项必选。
RDS
StorageTypestring

该参数暂未开放使用。

FromAppstring

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

OpenAPI
ClientTokenstring

输入任意字符串,用于保证请求幂等性。

KJSAHKJFHKJSHFKASHFKJADFHKDXXXX
ResourceGroupIdstring

资源组ID。

rg-aekzecovzti****

返回参数

名称类型描述示例值
object

返回值详情如下。

HttpStatusCodeinteger

HTTP状态码。

200
RequestIdstring

请求ID。

7BCF6D62-885F-5A4A-91A1-679760E7****
ErrCodestring

错误码。

Param.NotFound
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
BackupPlanIdstring

备份计划ID。

dbsrhahrsu2****
OrderIdstring

订单ID。

21437345592****

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=CreateBackupPlan
&Region=cn-hangzhou
&InstanceClass=micro
&DatabaseType=MySQL
&BackupMethod=logical
&公共请求参数

正常返回示例

JSON格式

{
  "RequestId": "7BCF6D62-885F-5A4A-91A1-679760E7****",
  "HttpStatusCode": 200,
  "BackupPlanId": "dbsrhahrsu2****",
  "OrderId": "21437345592****",
  "Success": true
}

XML格式

<CreateBackupPlanResponse>
    <RequestId>7BCF6D62-885F-5A4A-91A1-679760E7****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <BackupPlanId>dbsrhahrsu2****</BackupPlanId>
    <OrderId>21437345592****</OrderId>
    <Success>true</Success>
</CreateBackupPlanResponse>

错误码

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

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