API Introduction

Bind a Backup Policy to a Repository

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.

2. The backup policy and repository must both be existing resources.

3. The backup policy and the repository must be in the same enterprise project.

4. The backup policy has not been bound with any other repository. The repository cannot be anexpired one.

URI

<span lang="EN-US">POST /v4/ecs/backup-policy/bind-repo</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
repositoryID	Yes	String	CSBS repository ID. You can refer toProduct Definition - Repositoriesto learn more about repositories. More APIs:Query the Repository ListandCreate a Repository.	62a8c714-7f2a-4efb-b0b9-5542694c9c24
policyID	Yes	String	CSBS backup policy ID, in 32-bit. More APIs:Query the CSBS Backup Policy ListandCreate a CSBS Backup Policy.	c0f853a4a5c311edb27d0242ac110007

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 description upon a failure, usually in English.	SUCCESS
description	String	Error description upon a failure, usually in Chinese.	Successful
returnObj	Object	Response Parameters		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
repositoryID	String	Repository ID.	62a8c714-7f2a-4efb-b0b9-5542694c9c24
policyID	String	CSBS backup policy ID.	c0f853a4a5c311edb27d0242ac110007

Sample Request

Request Header

None

Request Body

                  "regionID": "bb9fdb42056f11eda1610242ac110002",

                  "policyID": "c0f853a4a5c311edb27d0242ac110007",

                  "repositoryID": "62a8c714-7f2a-4efb-b0b9-5542694c9c24"

Response Example

                  "returnObj": {

        "policyID": "c0f853a4a5c311edb27d0242ac110007",

        "repositoryID": "62a8c714-7f2a-4efb-b0b9-5542694c9c24"

},

                  "message": "SUCCESS",

                  "description": "Successful",

                  "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

Error Codes	Description
Openapi.PatternCheck.NotValid	The request parameter is invalid.
Openapi.EcsBackupCheck.UnknownError	Internal error. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EcsBackup.Repository.NotFound	The repository is not found.
EcsBackup.Parameter.Error	The request parameter is invalid.
EcsBackup.PolicyCheck.PolicyIdNotUUIDFormat	The ID of the backup policy must be in UUID format.
EcsBackup.PolicyCheck.NotFound	The backup policy is not found.
EcsBackup.PolicyCheck.NotValid	The backup policy has already been bound to the repository.
EcsBackup.RepoOrderCheck.RepoExpired	The repository is expired.
EcsBackup.Admin.AccessFailed	System error.

Cloud Server Backup Service

Bind a Backup Policy to a Repository