API Introduction

Create 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. Only the subscription billing mode is supported.

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

3. The repository capacity must be within 100 GB to 10,240 GB.

4. The repository capacity can only be upgraded.

5. The repository cannot be created in batch.

URI

<span lang="EN-US">POST /v4/ecs/backup-repo/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
projectID	No	String	Enterprise project ID. The enterprise project management feature allows you to manage resource by enterprise project and manage resources and members within each project.	0
repositoryName	Yes	String	Repository name. Only digits, letters, and hyphen (-) are allowed. The name cannot start with a digit or a hyphen (-) or end with a hyphen (-). It must be within 2 to 63 characters in length.	repo-test
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 duration type. Value range: MONTH and YEAR. The maximum yearly duration is 5 years.	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
size	No	Integer	Repository capacity (GB). Value range: [100-1024000]. Default value: 100.	100
autoRenewStatus	No	Integer	Specify whether to enable auto-renewal. Value range: 0: false. 1: true. Note: If you subscribe by month, the auto-renewal duration is three months. If you subscribe by year, the renewal duration is 1 year.	1

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
masterOrderID	String	Master order ID. The calling party can check status of the order and resources based on masterOrderID.	2dcbb4eca35011ed979b0242ac110002
masterOrderNO	String	Order Number	20230205172651675969
regionID	String	Resource Pool ID	bb9fdb42056f11eda1610242ac110002
masterResourceID	String	Master resource ID.	8adb4810aa8842efa1f2693537ae181c

Sample Request

Request Header

None

Request Body

Example: Subscribe a CSBS repository with 100 GB capacity for a month in East 1

                  "regionID": "bb9fdb42056f11eda1610242ac110002",

    "projectID": "0",

                  "repositoryName": "cbr-test-001",

                  "size": 100,

                  "clientToken": "sqlkjsdajdsal",

                  "cycleCount": 1,

                  "cycleType": "MONTH"

Response Example

                  "returnObj": {

                                     "masterResourceID": "8adb4810aa8842efa1f2693537ae181c",

                                     "masterOrderNO": "20230205172651675969",

                                     "regionID": "bb9fdb42056f11eda1610242ac110002",

                                     "masterOrderID": "2dcbb4eca35011ed979b0242ac110002"

},

                  "message": "SUCCESS",

                  "description": "Successful",

                  "statusCode": 800

Status Code

Status Code	Description
200	Indicate that the request succeeded

Error Codes

Error Codes	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.
Openapi.QuotaCheck.QuotaExceed	The user quota exceeds the system quota. Repository
EcsBackup.UserVisibleRegions.AccessFailed	Failed to query resource pools that are accessible to the user.
EcsBackup.RegionInfo.AccessFailed	Failed to query the resource pool.
EcsBackup.RegionInfo.Empty	The resource pool information is empty.
EcsBackup.RepositoryCheck.NameNotValid	The repository name is invalid.
EcsBackup.RepositoryCheck.SizeNotValid	The repository capacity is invalid.
EcsBackup.OrderCheck.InvalidProjectID	The enterprise project ID does not exist.
EcsBackup.Order.ProcFailed	Failed to process the order.

Cloud Server Backup Service

Create a CSBS Repository