API Introduction

Query the list of EVS disks bound with a backup policy.

API Restrictions

None

GET /v4/ebs-backup/policy/list-disks

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
pageNo	No	Integer	Page number. Default value: 1.	1
pageSize	No	Integer	Data entries on each page. Default: 10.	10
diskID	No	String	EVS ID	b9631b82-2087-4e54-b142-5640156ac932
diskName	No	String	Disk name. Fuzzy filter. When diskID is specified, this parameter does not take effect.	ecm

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	Lower-level Object
diskList	Yes	Array	EVS List		diskList
totalCount	Yes	Integer	Total number of disks.	20
currentCount	Yes	Integer	Number of disks on current page.	10

Table diskList

Parameter Name	Required or Not	Parameter Type	Description	Example
diskID	Yes	String	EVS ID	b9631b82-2087-4e54-b142-5640156ac932
diskName	Yes	String	EVS Name	ecm-test-0001-volume-000
diskSize	Yes	Integer	EVS disk capacity (GB).	40
diskStatus	Yes	String	Disk status, including available and in-use. Refer toVolume Status.	in-use
diskType	Yes	String	Disk type, including SATA, SAS, SSD-genric, SSD, and FAST-SSD.	SATA
diskMode	Yes	String	Disk mode, including VBD, ISCSI, and FCSAN.	VBD
createdTime	Yes	Integer	Created At	663136607
expiredTime	Yes	Integer	Expire In	663136607
instanceID	Yes	String	ID of the mounted cloud server.	bb46064b-5a94-4b77-881a-11fd1d6f8a6d
instanceName	Yes	String	Name of the mounted cloud server.	ecm-test-0001

Request Header

None

Request Body

None

    "returnObj": {

        "totalCount": 1,

        "currentCount": 1,

        "diskList": [{

            "instanceID": "bb46064b-5a94-4b77-881a-11fd1d6f8a6d",

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

            "expiredTime": 1677549810,

            "diskSize": 40,

            "diskMode": "VBD",

            "diskStatus": "in-use",

            "createdTime": 1672279410,

            "instanceName": "ecm-test-0001",

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

            "diskType": "SATA"

        }]},

    "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.InvalidPageParams	Invalid request parameter: {Error}
EbsBackup.Parameter.InvalidPolicyID	Invalid request parameter: {Error}
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.