Pauses a DBS backup schedule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopBackupPlan

The parameter specified by the system. Value: StopBackupPlan.

BackupPlanId String Yes dbstooi01XXXX

The ID of the backup plan.

StopMethod String Yes ALL

The pause mode. Valid values:

  • ALL: suspends a backup plan, a full data backup task, an incremental log backup task, or a restoration task.
  • PLAN: pause the backup PLAN only
RegionId String No cn-hangzhou

The region ID. You can call DescribeRegions query.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotency of the request.

Response parameters

Parameter Type Example Description
BackupPlanId String dbs1h****usfa

The ID of the backup plan.

ErrCode String Param.NotFound

The error code.

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

The error message.

HttpStatusCode Integer 200

The HTTP status code.

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

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=StopBackupPlan
&BackupPlanId=dbstooi01XXXX
&StopMethod=ALL
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.