Deleting Manual Backups in Batches
Function
This API is used to delete manual backups in batches. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependency
gaussdbformysql:backup:delete
Write
-
-
gaussdb:backup:delete
-
URI
DELETE /v3/{project_id}/backups
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
|
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range Default Value en-us |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
backup_ids |
Yes |
Array of strings |
Definition IDs of the manual backups to be deleted. To obtain this value, call the API for querying full backups. Constraints A maximum of 50 IDs are allowed. Range N/A Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
failed_results |
Array of DeleteBackupResult objects |
Definition Backup deletion error. Range If all backups are deleted successfully, this parameter is left blank. |
|
success_count |
Integer |
Definition Number of backups that have been deleted. Range 0–50 |
|
failed_count |
Integer |
Definition Number of backups that failed to be deleted. Range 0–50 |
|
Parameter |
Type |
Description |
|---|---|---|
|
backup_id |
String |
Definition Backup ID. Range N/A |
|
error_code |
String |
Definition Code returned when a task submission exception occurs. Range N/A |
|
error_msg |
String |
Definition Description returned when a task submission exception occurs. Range N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Deleting manual backups in batches
DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups
{
"backup_ids" : [ "53ad33abe43976054br07", "63ad3439af9776054br07" ]
}
Example Response
Status code: 200
Success.
{
"failed_results" : [ {
"backup_id" : "53ad33abe43976054br07",
"error_code" : "DBS.201204",
"error_msg" : "The backup type is not allowed."
}, {
"backup_id" : "63ad3439af9776054br07",
"error_code" : "DBS.201203",
"error_msg" : "The backup file does not exist."
} ],
"success_count" : 1,
"failed_count" : 2
}
SDK Sample Code
The SDK sample code is as follows.
Deleting manual backups in batches
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; import java.util.List; import java.util.ArrayList; public class BatchDeleteBackupSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); BatchDeleteBackupRequest request = new BatchDeleteBackupRequest(); BatchDeleteBackupRequestBody body = new BatchDeleteBackupRequestBody(); List<String> listbodyBackupIds = new ArrayList<>(); listbodyBackupIds.add("53ad33abe43976054br07"); listbodyBackupIds.add("63ad3439af9776054br07"); body.withBackupIds(listbodyBackupIds); request.withBody(body); try { BatchDeleteBackupResponse response = client.batchDeleteBackup(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Deleting manual backups in batches
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchDeleteBackupRequest() listBackupIdsbody = [ "53ad33abe43976054br07", "63ad3439af9776054br07" ] request.body = BatchDeleteBackupRequestBody( backup_ids=listBackupIdsbody ) response = client.batch_delete_backup(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Deleting manual backups in batches
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchDeleteBackupRequest{} var listBackupIdsbody = []string{ "53ad33abe43976054br07", "63ad3439af9776054br07", } request.Body = &model.BatchDeleteBackupRequestBody{ BackupIds: listBackupIdsbody, } response, err := client.BatchDeleteBackup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot