Creates a backup vault.
Operation description
-
Each Alibaba Cloud account can create up to 100 backup vaults.
-
After a backup vault is created, the backup vault is in the INITIALIZING state, and the system automatically runs an initialization task to initialize the backup vault. After the initialization task is completed, the backup vault is in the CREATED state. A backup job can use a backup vault to store backup data only if the backup vault is in the CREATED state.
**
Note Before you call this operation, make sure that you fully understand the billing of Cloud Backup.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| hbr:CreateVault | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| VaultRegionId | string | Yes | The ID of the region where the backup vault resides. | cn-shanghai |
| VaultName | string | Yes | The name of the backup vault. The name must be 1 to 64 characters in length. | backupvaultname |
| Description | string | No | The description of the backup vault. The description must be 0 to 255 characters in length. | description |
| VaultType | string | No | The type of the backup vault. Valid values:
| STANDARD |
| VaultStorageClass | string | No | The storage class of the backup vault. Valid value: STANDARD, which indicates standard storage. | STANDARD |
| EncryptType | string | No | The method that is used to encrypt the source data. This parameter is valid only if you set the VaultType parameter to STANDARD or OTS_BACKUP. Valid values:
| KMS |
| KmsKeyId | string | No | The customer master key (CMK) created in KMS or the alias of the key. This parameter is required only if you set the EncryptType parameter to KMS. | alias/yzs-hhht |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"VaultId": "v-*********************",
"Success": true,
"Code": "200",
"Message": "successful",
"TaskId": "t-*********************"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-02-23 | The internal configuration of the API is changed, but the call is not affected | View Change Details |