Changes to gaussdb_mysql_umn from docs/doc-exports#1161 (gaussdbmysql_umn_202404

Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

api-ref/source/apis_recommended/quota_management/configuring_resource_quotas.rst

@@ -13,6 +13,11 @@ This API is used to configure resource quotas for a specified enterprise project
 -  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
 -  Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
 
+Precautions
+-----------
+
+Before using this API, ensure that the enterprise project has been enabled and you have the **gaussdb:quota:modify** permission.
+
 URI
 ---
 

api-ref/source/apis_recommended/quota_management/modifying_resource_quotas.rst

@@ -13,6 +13,11 @@ This API is used to modify the resource quota of a specified enterprise project.
 -  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
 -  Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
 
+Precautions
+-----------
+
+Before using this API, ensure that the enterprise project has been enabled and you have the **gaussdb:quota:modify** permission.
+
 URI
 ---
 

api-ref/source/change_history.rst

@@ -8,6 +8,10 @@ Change History
 +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Released On                       | Description                                                                                                                                                                                                             |
 +===================================+=========================================================================================================================================================================================================================+
+| 2024-02-28                        | Modified the following content:                                                                                                                                                                                         |
+|                                   |                                                                                                                                                                                                                         |
+|                                   | Added precautions in :ref:`Configuring Resource Quotas <gaussdb_04_0012>` and :ref:`Modifying Resource Quotas <gaussdb_04_0013>`.                                                                                       |
++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 2023-10-25                        | Modified the following content:                                                                                                                                                                                         |
 |                                   |                                                                                                                                                                                                                         |
 |                                   | Modified the response parameters and examples in :ref:`Deleting a Manual Backup <deletegaussmysqlbackup>`.                                                                                                              |

umn/source/change_history.rst

@@ -8,6 +8,14 @@ Change History
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Released On                       | Description                                                                                                                                |
 +===================================+============================================================================================================================================+
+| 2024-04-15                        | Modified the following content:                                                                                                            |
+|                                   |                                                                                                                                            |
+|                                   | Added :ref:`Backup Space and Billing <gaussdb_03_0069>`.                                                                                   |
++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| 2024-02-28                        | Modified the following content:                                                                                                            |
+|                                   |                                                                                                                                            |
+|                                   | Modified the parameter description in :ref:`Setting Alarm Rules <gaussdb_03_0087>`.                                                        |
++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | 2023-11-13                        | Modified the following content:                                                                                                            |
 |                                   |                                                                                                                                            |
 |                                   | Allowed you to change the node names synchronously during DB instance name change in :ref:`Changing a DB Instance Name <gaussdb_03_0032>`. |

umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/backup_space_and_billing.rst

@@ -0,0 +1,58 @@
+:original_name: gaussdb_03_0069.html
+
+.. _gaussdb_03_0069:
+
+Backup Space and Billing
+========================
+
+Category
+--------
+
+-  The full backup mode is used to back up all target data even if no data is updated since the last backup.
+-  Incremental backup: The system automatically backs up data that has changed since the last automated backup or incremental backup in binlogs every 5 minutes. The binlogs can be used to restore data to a specified point in time.
+-  Differential backup: The system backs up data that has changed since the most recent full backup or differential backup in to physical files. Physical files cannot be used for log replay.
+-  Billable space: Backup space that you are billed for.
+-  Logical space: Space occupied by full backups.
+-  Physical space: The amount of data that is backed up to OBS.
+
+   .. note::
+
+      After you create a DB instance, the logical space is the same as the physical space. When a backup starts in a backup chain, the physical space stores the data of the first full backup and subsequent differential backups.
+
+Backup Space Calculation Methods
+--------------------------------
+
+There is a default backup chain (where there are seven backups). The first automated backup is a full backup, and subsequent automated backups are differential backups.
+
+In a backup chain, the backup space is released only after all full backups and differential backups are deleted.
+
+-  Logical space: Total size of the logical space - Logical size of the expired backup file
+-  Physical space: Size of the first full backup file + total size of subsequent differential backup files
+-  Free space: There is free backup storage up to 100% of your provisioned database storage.
+
+Billing is calculated as follows:
+
+The system deducts the free space from either the logical space or the physical space, whichever is smaller.
+
+Example
+-------
+
+A backup line contains seven backups by default. There are 11 backups shown in the following figure. The 1st backup to the 7th belong to one backup line and the 8th to the 11th belong to another.
+
+
+.. figure:: /_static/images/en-us_image_0000001896928157.png
+   :alt: **Figure 1** Backup example
+
+   **Figure 1** Backup example
+
+If there is 1,000 MB of backup space and the logical space is 1,000 MB each time, the physical space for the 1st backup is 1,000 MB. If the incremental data size is 100 MB each time, the physical space for the 2nd backup to 7th is 100 MB.
+
+A backup line contains seven backups by default. The physical space for the 8th backup is 1,000 MB because it represents a new backup line.
+
+Billed space includes the space of the two chains in the example.
+
+Suppose that after the 11th backup was created, and the 1st, 2nd and 3rd backups expired and were automatically deleted. The size of each space is calculated as follows:
+
+-  Total logical space size = Total logical space size - Logical size of the expired backup file (1,000 MB x 11 - 3,000 MB = 8,000 MB in this example).
+-  Physical space: size of data backed up to OBS. In this example, physical space includes the sum of physical space on the two backup links: 1,000 MB + (100 MB x 6) +1,000 MB+ (100 MB X 3) =2,900 MB
+-  Total billed space = Min (Total size of logical space, Total size of physical space) - free space, so the total billed space in this example = Min (8,000 MB, 2,900 MB) - 1,000 MB = 1,900 MB

umn/source/working_with_gaussdbfor_mysql/backups_and_restorations/index.rst

@@ -6,6 +6,7 @@ Backups and Restorations
 ========================
 
 -  :ref:`Working with Backups <gaussdb_03_0056>`
+-  :ref:`Backup Space and Billing <gaussdb_03_0069>`
 -  :ref:`Creating a Manual Backup <gaussdb_03_0058>`
 -  :ref:`Restoring Data from a Backup <gaussdb_03_0063>`
 -  :ref:`Deleting a Manual Backup <gaussdb_03_0068>`
@@ -15,6 +16,7 @@ Backups and Restorations
    :hidden: 
 
    working_with_backups
+   backup_space_and_billing
    creating_a_manual_backup
    restoring_data_from_a_backup
    deleting_a_manual_backup

umn/source/working_with_gaussdbfor_mysql/monitoring/setting_alarm_rules.rst

@@ -25,17 +25,33 @@ Procedure
 
 #. On the displayed page, set parameters as required.
 
-   -  Specify **Name** and **Description**.
+   .. table:: **Table 1** Parameter description
-   -  Select **Use template** for **Method**. The template contains the following common metrics: CPU usage, memory usage, and storage space usage.
-   -  Click |image2| to enable alarm notification. The validity period is 24 hours by default. If the topics you require are not displayed in the drop-down list, click **Create an SMN topic**. Then, select **Generated alarm** and **Cleared alarm** for **Trigger Condition**.
 
-      .. note::
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
-
+      | Parameter                         | Parameter description                                                                                                                                    |
-         Cloud Eye sends notifications only within the validity period specified in the alarm rule.
+      +===================================+==========================================================================================================================================================+
+      | Name                              | Alarm rule name. The system generates a random name, which you can modify.                                                                               |
+      |                                   |                                                                                                                                                          |
+      |                                   | Example value: **alarm-b6al**                                                                                                                            |
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Description                       | (Optional) Supplementary information about the alarm rule.                                                                                               |
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Method                            | There are two options: **Use existing template**, and **Configure manually**.                                                                            |
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Template                          | Template to be used.                                                                                                                                     |
+      |                                   |                                                                                                                                                          |
+      |                                   | You can select a default alarm template or create a custom template.                                                                                     |
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Alarm Notification                | Whether to notify users when alarms are triggered. Notifications can be sent by email, text message, or HTTP/HTTPS message.                              |
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Notification Object               | Object that receives alarm notifications. You can select the account contact or a topic.                                                                 |
+      |                                   |                                                                                                                                                          |
+      |                                   | -  Account contact is the mobile phone number and email address of the registered account.                                                               |
+      |                                   | -  Topic is used to publish messages and subscribe to notifications. If the required topic is unavailable, create one first and add subscriptions to it. |
+      +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 #. Click **Create**. The alarm rule is created.
 
    For operation details, see the *Cloud Eye User Guide*.
 
 .. |image1| image:: /_static/images/en-us_image_0000001403218685.png
-.. |image2| image:: /_static/images/en-us_image_0000001352538844.png