调动StartBackupPlan接口,启动一个DBS备份计划。

调试

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

请求参数

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

系统规定参数。取值:StartBackupPlan

BackupPlanId String dbsqdss5tmh****

备份计划ID,可通过调用DescribeBackupPlanList接口获取该参数的值。

RegionId String cn-hangzhou

地域ID,可通过调用DescribeRegions接口获取该参数的值。

ClientToken String ETnLKlblzczshOTUbOCzxxxxxxx

用于保证请求的幂等性,防止重复提交请求。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

HTTP·状态码。

RequestId String D13761C3-9971-5C02-B789-3F3CD159****

请求ID。

ErrCode String Param.NotFound

错误码。

Success Boolean true

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

  • true:请求成功
  • false:请求失败
ErrMessage String The specified parameter %s value is not valid.

错误信息。

CreatedFullBackupsetId String 1h7toien3****

全量备份集ID。

BackupPlanId String dbsqdss5tm****

备份计划ID。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=StartBackupPlan
&BackupPlanId=dbsqdss5tmh****
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxx
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<StartBackupPlanResponse>
    <RequestId>D13761C3-9971-5C02-B789-3F3CD159****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <BackupPlanId>dbsqdss5tmh***</BackupPlanId>
    <CreatedFullBackupsetId>1h7toien3****</CreatedFullBackupsetId>
    <Success>true</Success>
</StartBackupPlanResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D13761C3-9971-5C02-B789-3F3CD159****",
  "HttpStatusCode" : 200,
  "BackupPlanId" : "dbsqdss5tmh***",
  "CreatedFullBackupsetId" : "1h7toien3****",
  "Success" : true
}

错误码

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