调用StopBackupPlan接口,暂停一个DBS备份计划。

调试

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

请求参数

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

系统规定参数,取值:StopBackupPlan。

BackupPlanId String dbstooi01XXXX

备份计划ID。

StopMethod String ALL

暂停方式,取值:

  • ALL:暂停备份计划、全量数据备份任务、增量日志备份任务、恢复任务
  • PLAN:只暂停备份计划
RegionId String cn-hangzhou

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

ClientToken String ETnLKlblzczshOTUbOCzxxxxxxx

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

返回数据

名称 类型 示例值 描述
BackupPlanId String dbs1h****usfa

备份计划ID。

ErrCode String Param.NotFound

错误码。

ErrMessage String The specified parameter %s value is not valid.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String D6E068C3-25BC-455A-85FE-45F0B22ECB1F

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=StopBackupPlan
&BackupPlanId=dbstooi01XXXX
&StopMethod=ALL
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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