该接口用于创建一个DBS备份计划。
接口说明
本接口对应的控制台操作,请参见购买备份计划。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| dbs:CreateBackupPlan | create | *全部资源 * | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| Region | string | 否 | DBS 地域,该参数为必填项,可通过 DescribeRegions 查看 DBS 支持地域。 说明 
更多详情信息,请参见服务接入点。
 | cn-hangzhou | 
| InstanceClass | string | 是 | 规格,取值如下: 
 说明 
规格越高,备份与恢复的性能越高,更多信息,请参见规格说明。
 | micro | 
| DatabaseType | string | 是 | 数据库类型,取值如下: 
 | MySQL | 
| BackupMethod | string | 是 | 备份方式,取值如下: 
 | logical | 
| Period | string | 否 | 指定预付费实例为包年或者包月类型,取值如下: 
 | Month | 
| UsedTime | integer | 否 | 指定购买时长,取值如下: 
 | 1 | 
| PayType | string | 否 | 支付方式,取值如下: prepay:预付费(包年包月) | prepay | 
| DatabaseRegion | string | 否 | 数据库地域。 | cn-hangzhou | 
| StorageRegion | string | 否 | 存储地域。 | cn-hangzhou | 
| InstanceType | string | 否 | 数据库实例类型,取值如下: 
 | RDS | 
| StorageType | string | 否 | 该参数暂未开放使用。 | 无 | 
| FromApp | string | 否 | 用于备注请求来源,默认值为 OpenAPI,无需手动设置。 | OpenAPI | 
| ClientToken | string | 否 | 输入任意字符串,用于保证请求幂等性。 | KJSAHKJFHKJSHFKASHFKJADFHKDXXXX | 
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-aekzecovzti**** | 
返回参数
示例
正常返回示例
JSON格式
{
  "HttpStatusCode": 200,
  "RequestId": "7BCF6D62-885F-5A4A-91A1-679760E7****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbsrhahrsu2****",
  "OrderId": "21437345592****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作 | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|
暂无变更历史
