Back Up a Cloud Server

Immediately

API Introduction

This API provides

immediate backup capabilities for all cloud servers bound with the policy.

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 must be in the Enabled or Disabled state;

3. The backup policy must be bound to an available repository. If the repository has expired or has no remaining capacity, the repository is not available;

4. The backup policy must be bound to an available cloud server. For example, the sever is started or shut down.

URI

<span lang="EN-US">POST /v4/ecs/backup-policy/backup-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	Lower-level Object
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.	a2e8c1368b3911ed915f0242ac11000c

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.	c0f853a4a5c311edb27d0242ac110007

Sample Request

Example: Execute the backup policy to immediately back up all cloud servers bound with the policy

    "regionID":"bb9fdb42056f11eda1610242ac110002",

    "policyID":"a2e8c1368b3911ed915f0242ac11000c"

Request Header

None

Request Body

None

Response Example

    "returnObj": {

        "policyID":"a2e8c1368b3911ed915f0242ac11000c"

},

    "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.
EcsBackup.PolicyCheck.NotFound	The backup policy is not found.
EcsBackup.PolicyCheck.UnbindRepo	The backup policy is not bound to a repository.
EcsBackup.PolicyCheck.UnbindEcs	The backup policy is not bound to a cloud server.
EcsBackup.PolicyCheck.PolicyIdNotUUIDFormat	The ID of the backup policy must be in UUID format.
EcsBackup.RepositoryCheck.PolicyNotValid	The status of the backup policy is invalid.
EcsBackup.RepositoryCheck.AccessFailed	Failed to query the CSBS repository.
EcsBackup.RepositoryCheck.NotFound	The repository is not found.
EcsBackup.RepositoryCheck.DataDamaged	The repository data is incorrect.
EcsBackup.RepositoryCheck.Expired	The repository has expired.
EcsBackup.RepositoryCheck.SizeNull	The remaining capacity of the repository must be more than zero.
EcsBackup.PolicyCheck.InstanceStateNotValid	The cloud server must be running or shut down.
EcsBackup.Admin.AccessFailed	System error.

Cloud Server Backup Service

Execute a Backup Policy