API Introduction

Create a CSBS Backup 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 CSBS backup policy quantity must be within the quota.

URI

<span lang="EN-US">POST /v4/ecs/backup-policy/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 resource pools. More APIs:Query the Resource Pool List.	bb9fdb42056f11eda1610242ac110002
policyName	Yes	String	CSBS backup policy name. The name must be within 2 to 64 characters in length and can contain only digits, English letters, hyphens (-), underscores (_). and periods (.). Note: The name must be unique among all resource pools.	test-bak
cycleType	Yes	String	CSBS backup cycle. Value range: day and week.	day
cycleDay	No	Integer	CSBS backup cycle (Day). Value range: [1, 30]. Default value: 1. Note: This parameter is required only when cycleType is set to day.	1
cycleWeek	No	String	CSBS backup cycle (Week). Value range: 0 to 6, indicating different weekdays. 0 represents Sunday. Default value: 0. Note: This parameter is only required when cycleType is set to week. Separate multiple values with commas (,). For example, 0,3 indicates the backup operation is executed on Sunday and Wednesday.	0,2,6
time	No	String	Backup time, on the hour. Value range: 0 to 23. Separate multiple values with commas (,). For example, 11,15 indicates the backup operation is executed on 11 and 15 o'clock. Default value: 12.	1,20
status	No	Integer	Specify whether to enable the backup policy. Value range: 0 (no) and 1 (yes). Default value: 0.	1
retentionType	Yes	String	Retention type of the CSBS backup. Value range: date (by time), num (by number) and all (retained permanently).	date
retentionDay	No	Integer	Retention days of the CSBS backup. Value range: [1, 99999]. Default value: 1. Note: This parameter is required when retentionType is set to date.	30
retentionNum	No	Integer	Retention number of the CSBS backup. Value range: [1, 99999]. Default value: 1. Note: This parameter is required when retentionType is set to num.	20
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

Response 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 descripting in English.	SUCCESS
description	String	Error description in Chinese.	Successful
returnObj	Object	Return object.		returnObj

Table returnObj

Parameter	Parameter Type	Description	Example
status	Integer	Backup policy status.	1
policyName	String	Backup policy name.	test-123
retentionType	String	Backup retention type.	date
retentionDay	Integer	Retention period. This is returned when retentionType is set to date.	2
retentionNum	Integer	Number of retention. This data is returned when retentionType is set to num.	5
regionID	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
cycleType	String	Backup cycle type.	day
cycleDay	Integer	Return the cycle value when cycleType is set to day.	8
cycleWeek	String	Return the cycle value when cycleType is set to week.	4
policyID	String	Backup policy ID.	03b2d47aa3ae11eda7ae0242ac110009
time	String	Backup time, on the hour.	3
projectID	String	Enterprise project ID.	0

Sample Request

Request Header

None

Request Body

Example: Create a CSBS backup policy with a five-day cycle, conducted at 12 o'clock. The retention type is by number and num is set to 5. The policy status is Enabled.

    "regionID":"bb9fdb42056f11eda1610242ac110002",

    "policyName":"backup-01",

    "cycleType":"day",

    "cycleDay":5,

    "time":"12",

    "retentionType":"num",

    "retentionNum":5,

    "status":1

Response Example

    "returnObj": {

        "status": 1,

        "regionID": "bb9fdb42056f11eda1610242ac110002",

        "projectID": "0",

        "cycleDay": 5,

        "retentionNum": 5,

        "cycleType": "day",

        "policyID": "e58e56ea7d4111ee8a540242ac110002",

        "policyName": "backup-01",

        "retentionType": "num",

        "time": "12"

},

    "details": "",

    "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.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 or does not exist. Check whether the resource pool ID is valid.
EcsBackup.OrderCheck.InvalidProjectID	The enterprise project does not exist.
EcsBackup.PolicyCheck.OverQuota	The quota for the CSBS backup policies is exceeded.
EcsBackup.PolicyCheck.NameNotValid	The policyName value is invalid.
EcsBackup.PolicyCheck.PolicyNameExist	The CSBS backup policy name already exists.
EcsBackup.PolicyCheck.TimeNotValid	Value range of the time parameter is 0 to 23.
EcsBackup.PolicyCheck.StatusNotValid	Value range of the status parameter is 0 and 1.
EcsBackup.PolicyCheck.RetentionTypeRequired	The retentionType parameter is not specified.
EcsBackup.PolicyCheck.RetentionTypeNotValid	Value range of the retentionType parameter should be num, date, or all.
EcsBackup.PolicyCheck.RetentionDayNotValid	The retentionDay value is invalid.
EcsBackup.PolicyCheck.RetentionNumNotValid	The retentionNum value is invalid.
EcsBackup.PolicyCheck.CycleTypeRequired	The cycleType parameter is not specified.
EcsBackup.PolicyCheck.CycleTypeNotValid	Value range of cycleType should be day or week.
EcsBackup.PolicyCheck.CycleWeekNotValid	The cycleWeek value is invalid.
EcsBackup.PolicyCheck.CycleDayNotValid	The cycleDay value is invalid.
EcsBackup.Admin.AccessFailed	System error.

Cloud Server Backup Service

Create a CSBS Backup Policy