API Introduction

Query the CSBS Backup Policy List

Preparations :

Construct a request: Before you call an API, you must learn how to construct a request. For details, see Construct a Request.

Authentication: OpenAPI requests need to be encrypted. For details, see Authentication.

API Restrictions

1. Limitations: This API (beta) is only available to resource pools including Lhasa 3, Shanghai 7, Guangzhou 6, Chenzhou 2, Changsha 3, Beijing 5, Inner Mongolia 6, Nanjing 3, Chongqing 2, Hefei 2, Chengdu 4, Jinzhong, Kunming 2, Urumchi 27, Fuzhou 25, Hengyang 3, Changsha 37, Zhangjiajie 2, North 2, Beijing 1 (Central Enterprises), East 1, Shanghai 32, Shanghai 33, and Shanghai 36.

URI

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

Path Parameter

None

Query Parameter

None

Request Parameters

Request Header Parameter

None

Request Body Parameter

Parameter	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource pool ID. You can refer toRegions and Availability Zonesto learn more about resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
policyID	No	String	Backup policy ID, in 32-bit. More APIs:Query the CSBS Backup Policy ListandCreate a CSBS Backup Policy.	26da64d4a77f11ed923d0242ac110007
policyName	No	String	CSBS backup policy name. The name must be within 2 to 64 characters in length and can contain only digits, English letters, hyphens (-), underscores (_). and periods (.). Note: The name must be unique among all resource pools. Fuzzy filter. When policyID is specified, this parameter is set invalid.	test-bak
projectID	No	String	Enterprise project ID. The enterprise project management feature allows you to manage resource by enterprise project and manage resources and members within each project.	0
pageNo	No	Integer	Page number. Value range: Positive integer (≥1). Default value: 1.	1
pageSize	No	Integer	Number of records on each page. Value range: [1, 50]. Default value: 10.	10

Response Parameter

Parameter	Parameter Type	Description	Example	Lower-level Object
statusCode	Integer	Return status code (800 indicates success, 900 indicates failure).	800
errorCode	String	Business code, a three-segment code in the format of product.module.code. Refer toError Codesfor more details.	Openapi.PatternCheck.NotValid
message	String	Error descripting in English.	SUCCESS
description	String	Error description in Chinese.	Successful
returnObj	Object	Return object.		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
currentCount	Integer	Number of records on current page.	10
currentPage	Integer	Current page number.	1
totalCount	Integer	Total number of records.	20
totalPage	Integer	Total number of pages.	2
policyList	Array of Objects	Policy List		policyList

Table policyList

Parameter	Parameter Type	Description	Example	Lower-level Object
regionID	String	Resource pool ID. You can callregionIDto query the latest resource pool list of eSurfing Cloud.	81f7728662dd11ec810800155d307d5b
status	Integer	Indicate whether the policy is enabled. Value range: 0: disabled. 1: enabled.	1
policyID	String	CSBS backup policy ID.	d15e7d402f8f11ed81370242ac110006
policyName	String	Backup policy name.	test-policy
cycleType	String	Backup cycle. Value range: day and week.	day
cycleDay	Integer	Cycle data returned only when cycleType is set to day.	1
cycleWeek	String	Cycle data 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	String	Backup time, on hour. Value range: 0 to 23. Multiple values are separated with commas (,).	1,20
retentionType	String	Retention type of the CSBS backup. Value range: date (by time), num (by number) and all (retained permanently).	num
retentionNum	Integer	Number of retention returned only when retentionType is set to num.	1
retentionDay	Integer	Retention days returned only when retentionType is set to date.	1
resourceCount	Integer	Number of bound cloud servers.	2
resourceIDs	String	IDs of bound cloud servers, separated with commas (,).	9dda32dc-4180-48cf-8ddf-bb60c61fad22,da7e2058-9dad-4d23-baeb-3d614eec999a
repositoryList	Array of Objects	List of bound repositories.		repositoryList
projectID	String	Enterprise project ID.	0

Table repositoryList

Parameter	Parameter Type	Description	Example	Lower-level Object
repositoryID	String	CSBS repository ID.	9915c3f4-8d78-445a-a1da-d8d9287d506b
repositoryName	String	CSBS repository name.	test-repo

Sample Request

Request URL

Example: Query the list of backup policies

`GET .../openapi/v4/ecs/backup-policy/list?regionID=bb9fdb42056f11eda1610242ac110002`

Request Header

None

Request Body

None

Response Example

    "returnObj": {

        "currentCount": 1,

        "totalCount": 1,

        "totalPage": 1,

        "policyList": [

                "status": 1,

                "resourceCount": 1,

                "cycleDay": 4,

                "cycleType": "day",

                "policyID": "e14f067ea2d111ed98fd0242ac110007",

                "regionID": "81f7728662dd11ec810800155d307d5b",

                "policyName": "policy-b8b7",

                "retentionType": "date",

                "retentionDay": 90,

                "resourceIDs ": "543074a6-75a0-5e31-2c77-1501e3354f69",

                "time": "12,13,14,15",

                "projectID": "0",

                "repositoryList": [

                        "repositoryName": "repo-5d90",

                        "repositoryID": "7b9f5848-6a03-497b-8b12-e2ba5f90dc79"

],

        "currentPage": 1

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
EcsBackup.Parameter.InvalidregionID	The request parameter is invalid.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
Openapi.PatternCheck.NotValid	The request parameter is invalid.
EcsBackup.OrderCheck.InvalidProjectID	The enterprise project does not exist.
EcsBackup.Admin.AccessFailed	System error.

Cloud Server Backup Service

Query the CSBS Backup Policy List