API Introduction

Create a VBS backup policy.

API Restrictions

None

URI

<span lang="EN-US">POST /v4/ebs-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	81f7728662dd11ec810800155d307d5b
policyName	Yes	String	Policy name. The name must be unique and within the 2 to 64 characters length. The name can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-).	test-policy
status	No	Integer	Specify whether to enable the policy. Value range: 0: disabled. 1: enabled. Default value: 0.	0
cycleType	Yes	String	Backup cycle. Value range: day and week.	day
cycleDay	No	Integer	Backup cycle. This parameter is required only when cycleType is set to day.	1
cycleWeek	No	String	Backup cycle. This parameter is required only when cycleType is set to week. Valid values: 0 to 6, indicating Sunday to Saturday. Separate multiple values with commas (,).	0,2,6
time	Yes	String	Backup time, on hour. Value range: 0 to 23. Multiple values are separated with commas (,).	1,20
retentionType	Yes	String	Retention type of the backup. Value range: date: by time. num: by number. all: retained forever.	num
retentionNum	No	Integer	Retention number. This parameter is required only when retentionType is set to num. Valid values: 1 to 99999.	1
retentionDay	No	Integer	Retention days. This parameter is required only when retentionType is set to date. Valid values: 1 to 99999.	1
remainFirstOfCurMonth	No	Boolean	Specify whether to retain the first backup in each month. This parameter can be set when retentionType is set to num. Default value: false.	false
projectID	No	String	Enterprise project ID. Default value: 0.	0

Response Parameter

Parameter	Required or Not	Type	Description	Example	Lower-level Object
statusCode	Yes	Integer	Return status code (800 indicates success, 900 indicates failure).	800
message	Yes	String	Error descripting in English.	SUCCESS
description	Yes	String	Error description in Chinese.	Successful
returnObj	No	Object	Object returned upon a success.		returnObj
errorCode	No	String	Business code, returned upon failures.	Refer to error codes

Table returnObj

Parameter Name	Required or Not	Parameter Type	Description	Example
regionID	Yes	String	Resource Pool ID	81f7728662dd11ec810800155d307d5b
accountID	Yes	String	Account ID.	562b89493b1a40e1b97ea05e50dd8170
status	Yes	Integer	Status. Value range: 0: disabled. 1: enabled.	1
policyName	Yes	String	Policy name.	test-policy
cycleType	Yes	String	Backup cycle. Value range: day and week.	day
cycleDay	No	Integer	Backup cycle (Day), returned only when cycleType is set to day.	1
cycleWeek	No	String	Backup cycle (week), returned only when cycleType is set to week. Valid values: 0 to 6, indicating Sunday to Saturday. Multiple values are separated with commas (,).	0,2,6
time	Yes	String	Backup time, on hour. Value range: 0 to 23. Multiple values are separated with commas (,).	1,20
retentionType	Yes	String	Retention type of the backup. Value range: date: by time. num: by number. all: retained forever.	num
retentionNum	No	Integer	Retention number, returned only when retentionType is set to num.	1
retentionDay	No	Integer	Retention days, returned only when retentionType is set to date.	1
remainFirstOfCurMonth	No	Boolean	Indicate whether the first backup in each month is retained. This parameter is returned when retentionType is set to num. Default value: false.	false
projectID	Yes	String	Enterprise project ID.	0

Sample Request

Request Body

    "time": "0,4",

    "cycleType": "day",

    "cycleDay": 10,

    "status": 1,

    "policyName": "test_from_test_script1666145616.64",

    "regionID": "81f7728662dd11ec810800155d307d5b",

    "remainFirstOfCurMonth": true,

    "retentionType": "num",

    "retentionNum": 9999

Response Example

    "returnObj": {

        "status": 1,

        "policyName": "test_from_test_script1666145616.64",

        "retentionType": "num",

        "remainFirstOfCurMonth": true,

        "regionID": "81f7728662dd11ec810800155d307d5b",

        "cycleDay": 10,

        "retentionNum": 11,

        "cycleType": "day",

        "time": "0",

        "accountID": "552b89493b1a40e1b97ea05e50dd8170",

        "projectID": "0"

},

    "message": "SUCCESS",

    "description": "Successful",

    "statusCode": 800

Error Codes

errorCode	Description
EbsBackup.RegionInfo.Empty	The resource pool information is empty or does not exist. Check whether the resource pool ID is valid.
EbsBackup.RegionInfo.AccessFailed	Failed to query the resource pool. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.RegionInfo.DataDamaged	The resource pool information is incorrect. Please try again. If the failure keeps happening, please submit a ticket.
EbsBackup.Parameter.InvalidPolicyName	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidPolicyID	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidCycleType	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidCycleDay	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidCycleWeek	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidTime	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRetentionType	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRetentionDay	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRetentionNum	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRegionID	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidRemainFirstOfCurMonth	Invalid request parameter: {Reason}.
EbsBackup.Parameter.InvalidStatus	Invalid request parameter: {Reason}.
EbsBackup.PolicyInfo.OverQuota	The quota ({quota}) is exceeded.
EbsBackup.OrderCheck.InvalidProjectID	The enterprise project does not exist. Please check whether the project ID is valid.

Volume Backup Service

Create a Backup Policy