From 1dd141d7b4c6c1f4d1c51b539649e33f02642a74 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Tue, 7 Nov 2023 10:27:36 +0000 Subject: [PATCH] Changes to gaussdb_mysql_api-ref from docs/doc-exports#942 (Modified the respons Reviewed-by: Drobnak, David Co-authored-by: proposalbot Co-committed-by: proposalbot --- .../deleting_a_manual_backup.rst | 107 ++++++++++++++++++ .../backup_management/index.rst | 2 + api-ref/source/change_history.rst | 4 + 3 files changed, 113 insertions(+) create mode 100644 api-ref/source/apis_recommended/backup_management/deleting_a_manual_backup.rst diff --git a/api-ref/source/apis_recommended/backup_management/deleting_a_manual_backup.rst b/api-ref/source/apis_recommended/backup_management/deleting_a_manual_backup.rst new file mode 100644 index 0000000..ce206fb --- /dev/null +++ b/api-ref/source/apis_recommended/backup_management/deleting_a_manual_backup.rst @@ -0,0 +1,107 @@ +:original_name: DeleteGaussMySqlBackup.html + +.. _DeleteGaussMySqlBackup: + +Deleting a Manual Backup +======================== + +Function +-------- + +This API is used to delete a manual backup. Before calling this API: + +- Learn how to :ref:`authorize and authenticate ` it. +- Obtain the required :ref:`region and endpoint `. + +URI +--- + +DELETE /v3/{project_id}/backups/{backup_id} + +.. table:: **Table 1** URI parameters + + ========== ========= ====== =================================== + Parameter Mandatory Type Description + ========== ========= ====== =================================== + project_id Yes String Project ID of a tenant in a region. + backup_id Yes String Backup file ID. + ========== ========= ====== =================================== + +Request Parameters +------------------ + +.. table:: **Table 2** Request header parameters + + ============ ========= ====== =========== + Parameter Mandatory Type Description + ============ ========= ====== =========== + X-Auth-Token Yes String User token. + X-Language No String Language. + ============ ========= ====== =========== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameter + + =========== ====== ============ + Parameter Type Description + =========== ====== ============ + backup_id String Backup ID. + backup_name String Backup name. + =========== ====== ============ + +**Status code: 400** + +.. table:: **Table 4** Response body parameter + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +**Status code: 500** + +.. table:: **Table 5** Response body parameter + + ========== ====== ============== + Parameter Type Description + ========== ====== ============== + error_code String Error code. + error_msg String Error message. + ========== ====== ============== + +Example Request +--------------- + +.. code-block:: text + + DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/backups/1fe4feaab48f11e6654hfa163eba87e4b66 + +Example Response +---------------- + +**Status code: 200** + +Success. + +.. code-block:: + + { + "backup_id" : "b1182ccdda034f2b9535f3dca5c47e71br07", + "backup_name" : "backup-f3c1" + } + +Status Code +----------- + +For details, see :ref:`Status Codes `. + +Error Code +---------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/backup_management/index.rst b/api-ref/source/apis_recommended/backup_management/index.rst index 8f878be..c7b0e04 100644 --- a/api-ref/source/apis_recommended/backup_management/index.rst +++ b/api-ref/source/apis_recommended/backup_management/index.rst @@ -9,6 +9,7 @@ Backup Management - :ref:`Querying Backups ` - :ref:`Querying an Automated Backup Policy ` - :ref:`Modifying an Automated Backup Policy ` +- :ref:`Deleting a Manual Backup ` .. toctree:: :maxdepth: 1 @@ -18,3 +19,4 @@ Backup Management querying_backups querying_an_automated_backup_policy modifying_an_automated_backup_policy + deleting_a_manual_backup diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 493b637..c2c972e 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,10 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+=========================================================================================================================================================================================================================+ +| 2023-10-25 | Modified the following content: | +| | | +| | Modified the response parameters and examples in :ref:`Deleting a Manual Backup `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-10-20 | Modified the following content: | | | | | | Added the **total_count** field to the example response in :ref:`Querying Resource Quotas `. |