Creates a backup vault.

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.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateVault

The operation that you want to perform. Set the value to CreateVault.

VaultName String Yes backupvaultname

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

VaultRegionId String Yes cn-shanghai

The ID of the region where the backup vault resides.

Description String No description

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

VaultType String No STANDARD

The type of the backup vault. Valid value: STANDARD: common backup vault

VaultStorageClass String No STANDARD

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

Response parameters

Parameter Type Example Description
Code String 200

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

Message String successful

The message that is returned. If the request is successful, a value of successful is returned. If the request fails, an error message is returned.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: indicates that the request is successful.
  • false: indicates that the request fails.
TaskId String t-*********************

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

VaultId String v-*********************

The ID of the backup vault.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateVault
&VaultName=backupvaultname
&VaultRegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<CreateVaultResponse>
  <TaskId>t-*********************</TaskId>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <VaultId>v-*********************</VaultId>
  <Code>200</Code>
  <Success>true</Success>
</CreateVaultResponse>

JSON format

{
    "TaskId": "t-*********************",
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "VaultId": "v-*********************",
    "Code": 200,
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.