API Introduction

Query the backup task created based on a backup policy.

API Restrictions

None

<span lang="EN-US">GET /v4/ebs-backup/policy/show-task</span>

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
policyID	Yes	String	Backup policy ID.	d15e7d402f8f11ed81370242ac110006
taskID	Yes	String	Backup task ID	798aa810a1d511ed97520242ac110007

Request Header Parameter

None

Request Body Parameter

None

Parameter	Required or Not	Type	Description	Example	Lower-level Object
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	Object returned upon a success.		returnObj
errorCode	No	String	Business code, returned upon failures.	Refer to error codes

Table returnObj

Parameter Name	Required or Not	Parameter Type	Description	Example
taskID	Yes	String	Backup task ID	798aa810a1d511ed97520242ac110007
taskStatus	Yes	Integer	Backup task status. Valid values: -1: failed, 0: executing, and 1: successful.	1
diskID	Yes	String	EVS ID	4c26cefe-1aac-4b5a-9ac0-2a8eee8169d4
diskName	Yes	String	EVS Name	ebs-2f62
backupName	Yes	String	VBS Backup name.	autobk-6an5
createdTime	Yes	Integer	Created At	663136607
completedTime	Yes	Integer	Completed On	663136607

Request Header

None

Request Body

None

    "returnObj": {

        "diskName": "ecm-test-0001-volume-000",

        "backupName": "autobk-7ats",

        "completedTime": 1675965600,

        "taskStatus": -1,

        "taskID": "a0275276a8e611ed89ea0242ac110003",

        "createdTime": 1675965600,

        "diskID": "b9631b82-2087-4e54-b142-5640156ac932"},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

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.InvalidPolicyID	Invalid request parameter: {Error}
EbsBackup.Parameter.InvalidTaskID	Invalid request parameter: {Error}
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.
EbsBackup.PolicyInfo.TaskNotFound	The backup task is not found.