API Introduction

Query the list of VBS backup policies.

API Restrictions

None

URI

<span lang="EN-US">GET /v4/ebs-backup/policy/list-policies</span>

Path Parameter

None

Query Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
pageNo	No	Integer	Page number. Default value: 1.	1
pageSize	No	Integer	Number of records on each page. Default value: 10.	10
policyID	No	String	Backup policy ID.	d15e7d402f8f11ed81370242ac110006
policyName	No	String	Backup policy name. When policyID is specified, this parameter will be ignored.	test-policy
projectID	No	String	Enterprise project ID. Default value: 0.	0

Request Parameters

Request Header Parameter

None

Request Body Parameter

None

Response Parameter

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	Lower-level Object
policyList	Yes	Array	Policy List		policyList
totalCount	Yes	Integer	Policy quantity.	20
currentCount	Yes	Integer	Number of policies on current page.	10

Table policyList

Parameter Name	Required or Not	Parameter Type	Description	Example	Lower-level Object
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
accountID	Yes	String	Account ID.	562b89493b1a40e1b97ea05e50dd8170
status	Yes	Integer	Status. Value range: 0: disabled. 1: enabled.	1
createdTime	Yes	Integer	Created At	663136607
policyID	Yes	String	Policy ID.	d15e7d402f8f11ed81370242ac110006
policyName	Yes	String	Policy name.	test-policy
cycleType	Yes	String	Backup cycle. Value range: day and week.	day
cycleDay	No	Integer	Backup cycle (Day), returned only when cycleType is set to day.	1
cycleWeek	No	String	Backup cycle (week), returned only when cycleType is set to week. Valid values: 0 to 6, indicating Sunday to Saturday. Multiple values are separated with commas (,).	0,2,6
time	Yes	String	Backup time, on hour. Value range: 0 to 23. Multiple values are separated with commas (,).	1,20
retentionType	Yes	String	Retention type of the backup. Value range: date: by time. num: by number. all: retained forever.	num
retentionNum	No	Integer	Retention number, returned only when retentionType is set to num.	1
retentionDay	No	Integer	Retention days, returned only when retentionType is set to date.	1
remainFirstOfCurMonth	No	Boolean	Indicate whether the first backup in each month is retained. This parameter is returned when retentionType is set to num. Default value: false.	false
bindedDiskCount	Yes	Integer	Number of bound EVS disks.	2
bindedDiskIDs	Yes	String	IDs of bound EVS disks, separated with commas (,).	9dda32dc-4180-48cf-8ddf-bb60c61fad22,da7e2058-9dad-4d23-baeb-3d614eec999a
repositoryList	Yes	Array	List of VBS repositories bound with a policy.		repositoryList
projectID	Yes	String	Enterprise project ID.	0

Table repositoryList

Parameter Name	Required or Not	Parameter Type	Description	Example	Lower-level Object
repositoryID	Yes	String	Repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
repositoryName	Yes	String	VBS repository name.	test-repo

Sample Request

Request Header

None

Request Body

None

Response Example

    "returnObj": {

        "policyList": [{

            "status": 0,

            "bindedDiskIDs": "b9631b82-2087-4e54-b142-5640156ac932",

            "regionID": "41f64827f25f468595ffa3a5deb5d15d",

            "cycleDay": 1,

            "retentionNum": 1,

            "cycleType": "day",

            "policyID": "2ac3c7e6a75e11ed8fd40242ac110003",

            "bindedDiskCount": 1,

            "policyName": "test-script-1675825840.27",

            "remainFirstOfCurMonth": false,

            "retentionType": "num",

            "time": "10",

            "createdTime": 1675854640,

            "repositoryList": [{

                "repositoryName": "ak-47",

                "repositoryID": "fd2f33c0-74dc-4473-9ab8-21df377ea1f4"

}],

            "accountID": "19bf37bb87cc4c86aa2542b06b4fa032",

            "projectID": "0"

}],

        "totalCount": 1,

        "currentCount": 1},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Error Codes

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.InvalidRegionID	Invalid request parameter: {Reason}.
EbsBackup.OrderCheck.InvalidProjectID	The enterprise project ID does not exist.

Volume Backup Service

Query a Backup Policy