Create a CSBS Backup

API Introduction

Create a CSBS Backup

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 (Center Enterprises), East 1, Shanghai 32, Shanghai 33, and Shanghai 36.

2. The cloud server and backup repository must be existing ones.

3. The repository will be unavailable when the repository capacity is smaller than 0, or the repository is frozen or expired.

4. The cloud server must be in the Started or Shut Down state.

URI

<span lang="EN-US">POST /v4/ecs/backup/create</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 the resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
instanceID	Yes	String	Cloud server ID. You can refer toECSto learn more about cloud servers. More APIs:Query the Cloud Server List.	a628a7d9-ef97-3b16-8a0a-4a794fcdbc39
instanceBackupName	Yes	String	CSBS backup name. The name must start with a letter and be of 2 to 63 characters long. The name can contain digits, underscores (_), and hyphens (-).	api-temp01
instanceBackupDescription	No	String	CSBS backup description. The description cannot be within 256 characters.	creat_test01
repositoryID	Yes	String	CSBS repository ID. You can refer toProduct Definition - Repositoriesto learn more about repositories. More APIs:Query a RepositoryandCreate a Repository.	bbf404b5-8990-42a7-a144-c85ff4520276

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
results	Object	Backup result.		results

Table results

Parameter	Parameter Type	Description	Example
instanceBackupID	String	CSBS backup ID.	8a134233-5881-bacf-9ae0-992f4380698a
instanceBackupName	String	CSBS backup name.	api-temp01
instanceBackupStatus	String	Backup status. Value range: CREATING, ACTIVE, RESTORING, DELETING, EXPIRED, and ERROR.	CREATING
instanceBackupDescription	String	CSBS backup description.	create_test01
instanceID	String	Cloud server ID.	a628a7d9-ef97-3b16-8a0a-4a794fcdbc39
instanceName	String	Cloud Server Name	backupTS
repositoryID	String	CSBS repository ID.	bbf404b5-8990-42a7-a144-c85ff4520276
repositoryName	String	CSBS repository name.	api-temp01
diskTotalSize	Integer	Total disk capacity (GB).	40
usedSize	Integer	Used size of the VBS backup.	0
createdTime	String	Created At	2023-07-20T07:24:29Z
projectID	String	Enterprise project ID.	0

Sample Request

Request Header

None

Request Body

Example: Create a CSBS backup in the repository

    "regionID":"bb9fdb42056f11eda1610242ac110002",

    "instanceID":"cb51e0db-8e20-7434-4208-2a6fef86588f",

    "repositoryID":"96a06145-146d-4f6f-907c-34a7f57d7fda",

    "instanceBackupName":"test",

    "instanceBackupDescription":"test"

Response Example

    "returnObj": {

        "results": {

            "instanceBackupID": "36e17e43-f62d-060d-ce7c-ebac509faff9",

            "instanceBackupName": "test-0006",

            "instanceBackupDescription": "test",

            "instanceID": "cb51e0db-8e20-7434-4208-2a6fef86588f",

            "instanceName": "test",

            "repositoryID": "96a06145-146d-4f6f-907c-34a7f57d7fda",

            "repositoryName": "test",

            "instanceBackupStatus": "CREATING",

            "diskTotalSize": 45,

            "usedSize": 0,

            "createdTime": "2023-03-09T12:33:35Z",

            "projectID": "0"

},

    "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.
Ecs.Instance.NotFound	The cloud server is not found. Check whether the cloud server ID is correct.
Ecs.Instance.StatusNotValid	The cloud server status is invalid.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EcsBackup.WorkOrder.CreateFail	Failed to create the backup.
EcsBackup.Repository.NotFound	The CSBS repository does not exist.
EcsBackup.Repository.QueryFail	Failed to query the CSBS repository.
EcsBackup.Repository.Expired	The CSBS repository has expired.
EcsBackup.Repository.Freeze	The CSBS repository is frozen.
EcsBackup.Repository.Undercapacity	The repository capacity is insufficient.

Cloud Server Backup Service

Create a CSBS Backup