API Introduction

Bind a backup policy to a cloud server.

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 the cloud server must be within the same enterprise project.

3. The number of cloud servers that a backup policy is bound to must be within the quota.

4. The cloud server must be an existing one and in the Running or Shut Down state. A cloud server can only be bound with one backup policy.

URI

<span lang="EN-US">POST /v4/ecs/backup-policy/bind-instances</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	Yes	String	CSBS backup policy ID, in 32-bit. More APIs:Query the CSBS Backup Policy ListandCreate a CSBS Backup Policy.	e14f067ea2d111ed98fd0242ac110007
instanceIDList	Yes	String	Cloud server ID list. Separate multiple servers with commas (,). You can refer toECSto learn more about cloud servers. More APIs:Query the Cloud Server List,Create a Subscription or Pay-as-you-go Cloud Server, andCreate Subscription or Pay-as-you-go Cloud Servers in batch.	73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026

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
policyID	String	CSBS backup policy ID.	a2e8c1368b3911ed915f0242ac11000c
instanceIDList	String	One or more cloud server IDs. Multiple servers are separated with commas (,).	73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026

Sample Request

Request Header

None

Request Body

Example: Bind the backup policy to two cloud servers for them to back up based on the policy

    "regionID":"bb9fdb42056f11eda1610242ac110002",

    "instanceIDList":"73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026",

    "policyID":"e14f067ea2d111ed98fd0242ac110007"

Response Example

                  "returnObj": {

        "instanceIDList":"73f321ea-62ff-11ec-a8bc-005056898fe0,285010af-16f1-137e-06c0-920d4bdd0026",

        "policyID":"e14f067ea2d111ed98fd0242ac110007"

},

                  "message": "SUCCESS",

                  "description": "Successful",

                  "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

errorCode	Description
Openapi.PatternCheck.NotValid	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.
Ecs.Instance.NotFound	The cloud server is not found. Check whether the cloud server ID is correct.
Openapi.EcsWorkorder.AccessFailed	Failed to query the cloud server information. Please try again. If the failure keeps happening, please submit a ticket.
EcsBackup.PolicyCheck.NotFound	The backup policy is not found.
EcsBackup.PolicyCheck.OverQuota	The quota is exceeded.
EcsBackup.PolicyCheck.InstanceStateNotValid	The cloud server must be running or shut down.
EcsBackup.PolicyCheck.PolicyIdNotUUIDFormat	The ID of the backup policy must be in UUID format.
Openapi.Admin.AccessFailed	System error.
EcsBackup.PolicyCheck.ProjectIDMismatch	The enterprise project ID of the backup policy does not match that of the cloud server.
EcsBackup.Admin.AccessFailed	System error.

Cloud Server Backup Service

Bind a Backup Policy to a Cloud Server