API Introduction

Renew a CSBS 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 repository must be available.

URI

<span lang="EN-US">POST /v4/ecs/backup-repo/renew</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
repositoryID	Yes	String	CSBS repository ID. You can refer toProduct Definition - Repositoriesto learn more about repositories. More APIs:Query the Repository ListandCreate a Repository.	8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa
cycleCount	Yes	Integer	Subscription duration. This parameter must be used with cycleType. Note: The duration cannot exceed 60 months (5 years).	6
cycleType	Yes	String	Subscription type. Value range: MONTH and YEAR.	MONTH
clientToken	Yes	String	Client stub to ensure order idempotence. This parameter value must be unique within the same account. Requests with the same ClientToken value are considered as one request. The retention period is 24 hours.	4cf2962d-e92c-4c00-9181-cfbb2218636c

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.	Param is null
description	String	Error description upon a failure, usually in Chinese.	Request is null
returnObj	Object	Response parameter.		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example
masterOrderID	String	Master order ID. The calling party can check status of the order and resources based on masterOrderID.	dd834bf8499511edaba00242ac110002
masterOrderNO	String	Order Number	20221021170431655227
regionID	String	Resource Pool ID	bb9fdb42056f11eda1610242ac110002

Sample Request

Request Header

None

Request Body

Example: Renew a CSBS repository for one month in East 1

                  "regionID": "bb9fdb42056f11eda1610242ac110002",

                  "clientToken": "renew3103",

                  "repositoryID": "508e06e4-1911-4d93-8d3e-16f050aa3e28",

                  "cycleType": "MONTH",

                  "cycleCount": 1

Response Example

                  "returnObj": {

                                     "masterOrderNO": "20221021170431655227",

                                     "regionID": "bb9fdb42056f11eda1610242ac110002",

                                     "masterOrderID": "dd834bf8499511edaba00242ac110002"

},

                  "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.Repository.NotFound	The repository is not found.
EcsBackup.Parameter.InvalidError	The request parameter is invalid.
EcsBackup.Order.ProcFailed	Failed to process the order.
EcsBackup.Parameter.InvalidCycleCount	Invalid request parameter: The maximum subscription duration is 60 months. Please enter a valid value.

Cloud Server Backup Service