Customize Backup Vault Settings with UpdateVault API - Cloud Backup - Alibaba Cloud - Cloud Backup

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:UpdateVault

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	Yes	The ID of the backup vault.	v-*********************
VaultName	string	No	The name of the backup vault. The name must be 1 to 64 characters in length.	vaultname
Description	string	No	The description of the backup vault. The value must be 0 to 255 characters in length.	vault description
WormEnabled	boolean	No	Whether to enable the immutable backup feature for storage vaults. Once enabled, backup vaults and all backup data cannot be deleted until the retention period expires. This feature cannot be disabled after it is enabled. Only standard backup vaults and archive vaults support this feature.	true
ResourceGroupId	string	No	The ID of the resource group.	rg-acfm2fa2xeiebyy

Response elements

Element	Type	Description	Example
	object
Code	string	The response code. Status code 200 indicates that the request was successful.	200
Message	string	The returned message. A success message is returned for successful requests, and an error message for failed requests.	successful
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.