您可以调用CreateBackupPlan创建一个DBS备份计划。

调试

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

请求参数

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

系统规定参数,取值:CreateBackupPlan

BackupMethod String logical

备份方式,取值:

  • logical:逻辑备份
  • physical:物理备份
  • duplication:转储备份
DatabaseType String MySQL

数据库类型,取值:

  • MySQL
  • MSSQL
  • Oracle
  • MongoDB
  • Redis
InstanceClass String micro

规格,取值:

  • micro
  • small
  • medium
  • arge
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

指定购买时长,取值:

  • 当参数Period为Year时,UsedTime取值为1~9
  • 当参数Period为Month时,UsedTime取值为1~11
PayType String Postpaid

支付方式,取值:

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

数据库地域。

说明 当PayType为postpay时,该参数必选。
StorageRegion String cn-hangzhou

存储地域。

说明 当PayType为postpay时,该参数必选。
InstanceType String RDS

数据库实例类型,取值:

  • RDS
  • PolarDB
  • DDS
  • Kvstore
  • Other
    说明 当PayType为postpay时,必选。
StorageType String

该参数暂未开放使用。

FromApp String OpenApi

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

RegionId String cn-hangzhou

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

ClientToken String KJSAHKJFHKJSHFKASHFKJADFHKDJSLH

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

返回数据

名称 类型 示例值 描述
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 D6E068C3-25BC-455A-85FE-45F0B22ECB1F

请求ID。

Success Boolean true

是否成功。

示例

请求示例

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

正常返回示例

XML 格式

<CreateBackupPlanReponse>
  <RequestId>D6E068C3-25BC-455A-85FE-45F0B22ECB1F</RequestId>
  <HttpStatusCode>200</HttpStatusCode>
  <BackupPlanId>dbs1h****usfa</BackupPlanId>
  <OrderId>2056157****</OrderId>
  <Success>true</Success>
</CreateBackupPlanReponse>

JSON 格式

{
	"RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
	"HttpStatusCode": 200,
	"BackupPlanId": "dbs1h****usfa",
	"OrderId": "2056157****",
	"Success": true
}

错误码

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