All Products
Search
Document Center

Hybrid Backup Recovery:ExecuteBackupPlan

Last Updated:Nov 14, 2022

Executes a backup plan.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PlanIdstringYes

The ID of the backup plan.

plan-*********************
VaultIdstringYes

The ID of the backup vault.

v-*********************
SourceTypestringNo

The type of the data source. Valid values:

  • ECS_FILE: Elastic Compute Service (ECS) files
  • OSS: Object Storage Service (OSS) buckets
  • NAS: Apsara File Storage NAS file systems
ECS_FILE
RuleIdstringNo

The ID of the backup rule.

rule-0002*****ux8

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
JobIdstring

The ID of the backup job.

job-*********************

Example

Request example

http(s)://[Endpoint]/?Action=ExecuteBackupPlan
&PlanId=plan-*********************
&VaultId=v-*********************
&SourceType=ECS_FILE
&RuleId=rule-0002*****ux8
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "JobId": "job-*********************"
}

Error codes

For a list of error codes, visit the API error center.