All Products
Search
Document Center

Hybrid Backup Recovery:CreateVault

Last Updated:Nov 14, 2022

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultRegionIdstringYes

The ID of the region where the backup vault resides.

cn-shanghai
VaultNamestringYes

The name of the backup vault. The name must be 1 to 64 characters in length.

backupvaultname
DescriptionstringNo

The description of the backup vault. The description must be 0 to 255 characters in length.

description
VaultTypestringNo

The type of the backup vault. Valid value: STANDARD, which indicates a standard backup vault.

STANDARD
VaultStorageClassstringNo

The storage type of the backup vault. Valid value: STANDARD, which indicates standard storage.

STANDARD
EncryptTypestringNo

This parameter specifies the method that is used to encrypt the data in the backup vault.. This parameter is required only if the VaultType parameter is set to STANDARD.

  • HBR-managed (default value): You can use the default encryption method of HBR.
  • KMS: You can use Key Management Service (KMS) to encrypt data that is stored in the backup vault. If you select this option, you must specify the KMS KeyId parameter.
KMS
KmsKeyIdstringNo

You can use Key Management Service (KMS) to encrypt data that is stored in the backup vault. If you select this option, you must specify the KMS KeyId parameter.

alias/yzs-hhht
EndpointstringNo

The default endpoint. Cross-region access is not supported.

oss-cn-shenzhen.aliyuncs.com
BucketNamestringNo

The name of the bucket in a custom cluster.

device-static
VaultAccessKeyIdstringNo

The AccessKey ID of your Alibaba Cloud account.

LTAI********************DC6Fy7e
VaultAccessKeySecretstringNo

The AccessKey secret of your Alibaba Cloud account.

IrVT*******************CEHXeFE
CompressionAlgorithmstringNo

The encryption algorithm used to compress the backup vault. Valid values:

  • DISABLED: The backup vault is not compressed.
  • SNAPPY: The backup vault is compressed by using the SNAPPY encryption algorithm.
  • ZSTD: The backup vault is compressed by using Zstandard, a fast compression algorithm that provides high compression ratios.
ZSTD
RedundancyTypestringNo

The data redundancy type of the backup vault. Valid values:

  • LRS: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.
  • ZRS: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone becomes unavailable, the data can still be accessed.
LRS

Response parameters

ParameterTypeDescriptionExample
object

The reponse body.

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VaultIdstring

The ID of the backup vault.

v-*********************
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
TaskIdstring

The ID of the initialization task used to initialize the backup vault. You can call the DescribeTask operation to query the status of an initialization task.

t-*********************

Example

Request example

http(s)://[Endpoint]/?Action=CreateVault
&VaultRegionId=cn-shanghai
&VaultName=backupvaultname
&Description=description
&VaultType=STANDARD
&VaultStorageClass=STANDARD
&Endpoint=oss-cn-shenzhen.aliyuncs.com
&BucketName=device-static
&VaultAccessKeyId=LTAI********************DC6Fy7e
&VaultAccessKeySecret=IrVT*******************CEHXeFE
&CompressionAlgorithm=ZSTD
&RedundancyType=LRS
&Common request parameters

Normal return example

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 API error center.

Change history

Change timeSummary of changesOperate
2022-01-26OpenAPI CreateVault is offline
Change itemChange content