DeleteSnapshot - Cloud Backup - Alibaba Cloud Documentation Center

Deletes a backup snapshot.

Operation description

If you delete the most recent backup snapshot for a data source, you must set the Force parameter to true. Otherwise, an error occurs.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:DeleteSnapshot	delete	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Token	string	No	The token that you want to delete.	02WJDOE7
VaultId	string	No	The ID of the backup vault.	v-*********************
ClientId	string	No	The ID of the Cloud Backup client. If you delete a backup snapshot for Elastic Compute Service (ECS) instances, you must specify one of the ClientId and InstanceId parameters.	c-*********************
SnapshotId	string	Yes	The ID of the backup snapshot.	s-*********************
SourceType	string	No	The type of the backup source. Valid values: ECS_FILE: backup snapshots for ECS files OSS: backup snapshots for Object Storage Service (OSS) buckets NAS: backup snapshots for Apsara File Storage NAS (NAS) file systems	ECS_FILE
InstanceId	string	No	The ID of the ECS instance. If you delete a backup snapshot for ECS instances, you must specify one of the InstanceId and ClientId parameters.	i-*********************
Force	boolean	No	Specifies whether to forcibly delete the most recent backup snapshot. Valid values: true: The system forcibly deletes the most recent backup snapshot. false (default): The system does not forcibly delete the most recent backup snapshot.	false

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The response code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.	successful
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history