API Introduction

Change the name and description of 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 (Central Enterprises), East 1, Shanghai 32, Shanghai 33, and Shanghai 36.

2. The CSBS backup must be an existing one.

URI

<span lang="EN-US">POST /v4/ecs/backup/update</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
instanceBackupID	Yes	String	CSBS backup ID. You can refer toProduct Definition - CSBSto learn more about CSBS. More APIs:Query a CSBS BackupandCreate a CSBS Backup.	b6e2966d-7b1c-385e-abe4-d940caa273b7
instanceBackupName	Yes	String	CSBS backup name. The name must start with a letter and be within 2 to 63 characters. The name can contain digits, underscores (_), and hyphens (-). Note: The name must be unique among all resource pools.	update-test01
instanceBackupDescription	No	String	CSBS backup description. The description cannot be within 256 characters.	api_update_test01

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	Return result.		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example	Lower-level Object
instanceBackupID	String	CSBS backup ID.	b6e2966d-7b1c-385e-abe4-d940caa273b7

Sample Request

Request Header

None

Request Body

Example: Update the name and description of a CSBS backup

    "regionID": "bb9fdb42056f11eda1610242ac110002",

    "instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7",

    "instanceBackupName": "test_zz-0001-zzy1",

    "instanceBackupDescription": "ecs-backups-test_zz-0001-zzy"

Response Example

    "returnObj": {

        "instanceBackupID": "b6e2966d-7b1c-385e-abe4-d940caa273b7"

},

    "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.WorkOrder.QueryFail	Failed to obtain the CSBS backup.
EcsBackup.Backup.NotFound	The CSBS backup is not found.
EcsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EcsBackup.Backup.NameExist	The CSBS backup name already exists.
EcsBackup.Backup.UpdateInfoNotValid	The parameter to be modified is invalid. Specify the backup name or description.
EcsBackup.WorkOrder.UpdateFail	Failed to modify the CSBS backup information.
EcsBackup.Backup.NoChange	The backup information is not updated.

Cloud Server Backup Service

Update the CSBS Backup Info