API Introduction

Execute a backup policy immediately. All EVS disks bound with the backup policy will conduct a backup operation immediately.

API Restrictions

Backup policies can only be executed when they are bound to backup repositories and EVS disks.

POST /v4/ebs-backup/policy/execute

Path Parameter

None

Query Parameter

None

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example	Lower-level Object
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
policyID	Yes	String	Backup policy ID.	d15e7d402f8f11ed81370242ac110006

Parameter	Required or Not	Type	Description	Example
statusCode	Yes	Integer	Return status code (800 indicates success, 900 indicates failure).	800
message	Yes	String	Error descripting in English.	SUCCESS
description	Yes	String	Error description in Chinese.	Successful
returnObj	No	Object	Data returned upon success. Value: {}.
errorCode	No	String	Business code, returned upon failures.	Refer to error codes

Request Header

None

Request Body

    "regionID": "81f7728662dd11ec810800155d307d5b",

    "policyID": "b77b1ecc4f5d11ed8caa0242ac110002"

    "statusCode": 800,

    "message": "SUCCESS",

    "description": "Successful",

    "returnObj": {}

errorCode	Description
EbsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EbsBackup.RegionInfo.AccessFailed	Failed to query the resource pool. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.RegionInfo.DataDamaged	The resource pool information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.Parameter.InvalidPageParams	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidPolicyID	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidUuidParams	Invalid request parameter: {Reason}.
EbsBackup.PolicyInfo.NotFound	The backup policy is not found.
EbsBackup.PolicyInfo.UnbindRepo	The backup policy is not bound to a repository.
EbsBackup.PolicyInfo.UnbindVolumes	The backup policy is not bound to an EVS disk.
EbsBackup.PolicyInfo.Backingup	All bound EVS disks are in the process of backup.