Deleting Manual Backups in Batches (RDS for SQL Server)

Function

This API is used to delete manual backups in batches.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

This API is only available for RDS for SQL Server instances.

URI

• URI format

  POST /v3/{project_id}/backups/batch-delete

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request

Example Request

Delete manual backups in batches.

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/batch-delete

{ 
  "backup_ids" : [ "53ad33abe43976054br04", "63ad3439af9776054br04" ] 
}

Response

• Response parameters

  Table 3 Response body parameters

  Parameter	Type	Description
  delete_results	Array of objects	Definition Backup deletion results. For details, see Table 4.

  Table 4 delete_results field data structure description

  Parameter	Type	Description
  backup_id	String	Definition Backup ID. Range N/A
  error_code	String	Definition Code returned after a task is submitted. Range If the task is executed successfully, 0 is returned. If the task fails to be executed, the specific error code is returned.
  error_msg	String	Definition Description returned after a task is submitted. Range If the task is executed successfully, Success is returned. If the task fails to be executed, the specific error information is returned.

• Example response

  { 
    "delete_results" : [ { 
      "backup_id" : "dsfae23fsfdsae3435br04", 
      "error_code" : "DBS.200054", 
      "error_msg" : "the backup is in use" 
    } , 
  { 
      "backup_id" : "ed23545223fsfdsae3435br04", 
      "error_code" : "0", 
      "error_msg" : "Success" 
    } 
  ] }

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.