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/api/index.rst

@@ -1,24 +0,0 @@
-:original_name: gaussdb_04_0000.html
-
-.. _gaussdb_04_0000:
-
-API
-===
-
--  :ref:`Querying Version Information About a DB Engine <gaussdb_04_0001>`
--  :ref:`Querying Database Specifications <gaussdb_04_0002>`
--  :ref:`Managing DB Instances <gaussdb_04_0003>`
--  :ref:`Managing Parameter Templates <gaussdb_04_0008>`
--  :ref:`Managing Quotas <gaussdb_04_0010>`
--  :ref:`Obtaining Task Information <gaussdb_04_0014>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_version_information_about_a_db_engine
-   querying_database_specifications
-   managing_db_instances/index
-   managing_parameter_templates/index
-   managing_quotas/index
-   obtaining_task_information

api-ref/source/api/managing_db_instances/deleting_a_db_instance.rst

@@ -1,75 +0,0 @@
-:original_name: gaussdb_04_0007.html
-
-.. _gaussdb_04_0007:
-
-Deleting a DB Instance
-======================
-
-Function
---------
-
-This API is used to delete a DB instance.
-
--  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
--  Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
-
-URI
----
-
--  URI format
-
-   DELETE https://{*Endpoint*}/mysql/v3/{project_id}/instances/{instance_id}
-
--  Example
-
-   DELETE https://{*Endpoint*}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01
-
--  Parameter description
-
-   .. table:: **Table 1** Parameter description
-
-      +-----------------------+-----------------------+----------------------------------------------------------------------------+
-      | Name                  | Mandatory             | Description                                                                |
-      +=======================+=======================+============================================================================+
-      | project_id            | Yes                   | Project ID of a tenant in a region.                                        |
-      |                       |                       |                                                                            |
-      |                       |                       | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`. |
-      +-----------------------+-----------------------+----------------------------------------------------------------------------+
-      | instance_id           | Yes                   | DB instance ID, which is compliant with the UUID format.                   |
-      +-----------------------+-----------------------+----------------------------------------------------------------------------+
-
-Request
--------
-
-None.
-
-Response
---------
-
--  Normal response
-
-   .. table:: **Table 2** Parameter description
-
-      ====== ====== ====================================
-      Name   Type   Description
-      ====== ====== ====================================
-      job_id String ID of the DB instance deletion task.
-      ====== ====== ====================================
-
--  Example normal response
-
-   .. code-block:: text
-
-      {
-          "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
-      }
-
-Status Code
------------
-
-For details, see :ref:`Status Codes <gaussdb_10_0002>`.
-
-Error Code
-----------
-
-For details, see :ref:`Error Codes <gaussdb_10_0003>`.

api-ref/source/api/managing_db_instances/index.rst

@@ -1,20 +0,0 @@
-:original_name: gaussdb_04_0003.html
-
-.. _gaussdb_04_0003:
-
-Managing DB Instances
-=====================
-
--  :ref:`Creating a DB instance <gaussdb_04_0004>`
--  :ref:`Querying a DB Instance List <gaussdb_04_0005>`
--  :ref:`Querying Details of a DB Instance <gaussdb_04_0006>`
--  :ref:`Deleting a DB Instance <gaussdb_04_0007>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   creating_a_db_instance
-   querying_a_db_instance_list
-   querying_details_of_a_db_instance
-   deleting_a_db_instance

api-ref/source/api/managing_parameter_templates/index.rst

@@ -1,14 +0,0 @@
-:original_name: gaussdb_04_0008.html
-
-.. _gaussdb_04_0008:
-
-Managing Parameter Templates
-============================
-
--  :ref:`Querying a Parameter Template <gaussdb_04_0009>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_a_parameter_template

api-ref/source/api/querying_version_information_about_a_db_engine.rst

@@ -1,92 +0,0 @@
-:original_name: gaussdb_04_0001.html
-
-.. _gaussdb_04_0001:
-
-Querying Version Information About a DB Engine
-==============================================
-
-Function
---------
-
-This API is used to query the DB version information of a specified DB engine.
-
--  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` this API before using it.
--  Before calling this API, obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
-
-URI
----
-
--  URI format
-
-   GET https://{*Endpoint*}/mysql/v3/{project_id}/datastores/{database_name}
-
--  Example
-
-   GET https://{*Endpoint*}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/datastores/gaussdb-mysql
-
--  Parameter description
-
-   .. table:: **Table 1** Parameter description
-
-      +-----------------------+-----------------------+-----------------------------------------------------------------------------------+
-      | Name                  | Mandatory             | Description                                                                       |
-      +=======================+=======================+===================================================================================+
-      | project_id            | Yes                   | Project ID of a tenant in a region.                                               |
-      |                       |                       |                                                                                   |
-      |                       |                       | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`.        |
-      +-----------------------+-----------------------+-----------------------------------------------------------------------------------+
-      | database_name         | Yes                   | DB engine. The following DB engine is supported (case-insensitive): gaussdb-mysql |
-      +-----------------------+-----------------------+-----------------------------------------------------------------------------------+
-
-Request
--------
-
-None.
-
-Response
---------
-
--  Normal response
-
-   .. table:: **Table 2** Parameter description
-
-      +-----------------------+-----------------------+-------------------------------------------------------------------+
-      | Name                  | Type                  | Description                                                       |
-      +=======================+=======================+===================================================================+
-      | datastores            | Array of objects      | DB version list.                                                  |
-      |                       |                       |                                                                   |
-      |                       |                       | For details, see :ref:`Table 3 <gaussdb_04_0001__table66531170>`. |
-      +-----------------------+-----------------------+-------------------------------------------------------------------+
-
-   .. _gaussdb_04_0001__table66531170:
-
-   .. table:: **Table 3** datastores field data structure description
-
-      +------+--------+-------------------------------------------------------------------------------+
-      | Name | Type   | Description                                                                   |
-      +======+========+===============================================================================+
-      | id   | String | DB version ID. Its value is unique.                                           |
-      +------+--------+-------------------------------------------------------------------------------+
-      | name | String | DB version number. Only the major version number with two digits is returned. |
-      +------+--------+-------------------------------------------------------------------------------+
-
--  Example normal response
-
-   .. code-block:: text
-
-      {
-               "datastores": [{
-                         "id": "87620726-6802-46c0-9028-a8785e1f1921",
-                         "name": "8.0"
-               }]
-      }
-
-Status Code
------------
-
-For details, see :ref:`Status Codes <gaussdb_10_0002>`.
-
-Error Code
-----------
-
-For details, see :ref:`Error Codes <gaussdb_10_0003>`.

api-ref/source/api_overview.rst

@@ -7,18 +7,26 @@ API Overview
 
 With GaussDB(for MySQL) APIs, you can query, set, and modify resource quotas.
 
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| Type                          | Description                                                                                                                                   |
-+===============================+===============================================================================================================================================+
-| DB engine version query       | Query the DB version information of a specified DB engine.                                                                                    |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| DB specifications query       | Query the DB specifications of a specified DB engine version.                                                                                 |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| DB instance management        | Create DB instances, query DB instance lists, query DB instance details, delete DB instances, create read replicas, and delete read replicas. |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| Parameter template management | Query parameter templates.                                                                                                                    |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| Quota management              | Query, set, and modify resource quotas.                                                                                                       |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
-| Task information query        | Obtain task information about the task center.                                                                                                |
-+-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Type                          | Description                                                                                                                                                                                                        |
++===============================+====================================================================================================================================================================================================================+
+| DB engine version query       | Query the DB version information of a specified DB engine.                                                                                                                                                         |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DB specifications query       | Query the DB specifications of a specified DB engine version.                                                                                                                                                      |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DB instance management        | Create instances, query instance lists, query instance details, delete instances, create read replicas, delete read replicas, change instance names, reset database passwords, and change instance specifications. |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Backup management             | Create manual backups, query backup lists, query automated backup policies, and modify automated backup policies.                                                                                                  |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Parameter template management | Query parameter templates.                                                                                                                                                                                         |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Quota management              | Query, set, and modify resource quotas.                                                                                                                                                                            |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Database proxy                | Query database proxy information and specifications, and enable or disable database proxy.                                                                                                                         |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Log management                | Obtain log information, including database error logs and slow logs.                                                                                                                                               |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Tag management                | Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags.                                                                                                                |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Task center                   | Obtain task information about the task center.                                                                                                                                                                     |
++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

api-ref/source/api_usage_guidelines/authentication.rst

@@ -18,6 +18,32 @@ Token-based Authentication
 
 A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.
 
+.. code-block::
+
+   {
+        "auth": {
+            "identity": {
+                "methods": [
+                    "password"
+                ],
+                "password": {
+                    "user": {
+                        "name": "username",
+                        "password": "********",
+                        "domain": {
+                            "name": "domainname"
+                        }
+                    }
+                }
+            },
+            "scope": {
+                "project": {
+                    "name": "xxxxxxxx"
+                }
+            }
+        }
+    }
+
 In :ref:`Making an API Request <gaussdb_03_0005>`, the process of calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__ is described.
 
 After a token is obtained, add the **X-Auth-Token** header field must be added to requests to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows:

api-ref/source/api_usage_guidelines/index.rst

@@ -2,8 +2,8 @@
 
 .. _gaussdb_03_0000:
 
-Calling APIs
-============
+API Usage Guidelines
+====================
 
 -  :ref:`Making an API Request <gaussdb_03_0005>`
 -  :ref:`Authentication <gaussdb_03_0001>`

api-ref/source/api_usage_guidelines/making_an_api_request.rst

@@ -95,7 +95,7 @@ This part is optional. The body of a request is often sent in a structured forma
 
 The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
 
-In the case of the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace **username**, **domainname**, **\*******\*** (login password), and **xxxxxxxxxxxxxxxxxx** (project name) with actual values. You can obtain the values from `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__.
+In the case of the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace **username**, **domainname**, **\*******\*** (login password), and **xxxxxxxxxxxxxxxxxx** (project name) with actual values. It can be obtained from `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__.
 
 .. note::
 

api-ref/source/api_usage_guidelines/response.rst

@@ -23,7 +23,7 @@ Similar to a request, a response also has a header, for example, **Content-Type*
 
 .. _gaussdb_03_0006__fig4865141011511:
 
-.. figure:: /_static/images/en-us_image_0000001372529646.png
+.. figure:: /_static/images/en-us_image_0000001427231638.png
    :alt: **Figure 1** Header fields of the response to the request for obtaining a user token
 
    **Figure 1** Header fields of the response to the request for obtaining a user token

api-ref/source/apis_recommended/backup_management/index.rst

@@ -0,0 +1,22 @@
+:original_name: gaussdb_06_0002.html
+
+.. _gaussdb_06_0002:
+
+Backup Management
+=================
+
+-  :ref:`Creating a Manual Backup <gaussdb_06_0003>`
+-  :ref:`Querying Backups <gaussdb_06_0004>`
+-  :ref:`Querying an Automated Backup Policy <gaussdb_06_0005>`
+-  :ref:`Modifying an Automated Backup Policy <gaussdb_06_0006>`
+-  :ref:`Deleting a Manual Backup <deletegaussmysqlbackup>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   creating_a_manual_backup
+   querying_backups
+   querying_an_automated_backup_policy
+   modifying_an_automated_backup_policy
+   deleting_a_manual_backup

api-ref/source/apis_recommended/database_proxy/index.rst

@@ -0,0 +1,26 @@
+:original_name: topic_300000006.html
+
+.. _topic_300000006:
+
+Database Proxy
+==============
+
+-  :ref:`Enabling Database Proxy <creategaussmysqlproxy>`
+-  :ref:`Disabling Database Proxy <deletegaussmysqlproxy>`
+-  :ref:`Querying Database Proxy Instances <showgaussmysqlproxylist>`
+-  :ref:`Querying Database Proxy Specifications <showgaussmysqlproxyflavors>`
+-  :ref:`Adding Database Proxy Nodes <expandgaussmysqlproxy>`
+-  :ref:`Changing Specifications of a Database Proxy Instance <changegaussmysqlproxyspecification>`
+-  :ref:`Assigning Read Weights <setgaussmysqlproxyweight>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   enabling_database_proxy
+   disabling_database_proxy
+   querying_database_proxy_instances
+   querying_database_proxy_specifications
+   adding_database_proxy_nodes
+   changing_specifications_of_a_database_proxy_instance
+   assigning_read_weights

api-ref/source/apis_recommended/index.rst

@@ -0,0 +1,32 @@
+:original_name: gaussdb_04_0000.html
+
+.. _gaussdb_04_0000:
+
+APIs (Recommended)
+==================
+
+-  :ref:`Querying Version Information About a DB Engine <gaussdb_04_0001>`
+-  :ref:`Querying Database Specifications <gaussdb_04_0002>`
+-  :ref:`Managing DB Instances <gaussdb_04_0003>`
+-  :ref:`Backup Management <gaussdb_06_0002>`
+-  :ref:`Parameter Template Management <gaussdb_04_0008>`
+-  :ref:`Quota Management <gaussdb_04_0010>`
+-  :ref:`Database Proxy <topic_300000006>`
+-  :ref:`Log Management <topic_300000007>`
+-  :ref:`Tag Management <topic_300000009>`
+-  :ref:`Task Center <gaussdb_04_0014>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_version_information_about_a_db_engine
+   querying_database_specifications
+   managing_db_instances/index
+   backup_management/index
+   parameter_template_management/index
+   quota_management/index
+   database_proxy/index
+   log_management/index
+   tag_management/index
+   task_center/index

api-ref/source/apis_recommended/log_management/index.rst

@@ -0,0 +1,16 @@
+:original_name: topic_300000007.html
+
+.. _topic_300000007:
+
+Log Management
+==============
+
+-  :ref:`Querying Database Error Logs <listgaussmysqlerrorlog>`
+-  :ref:`Querying Database Slow Logs <listgaussmysqlslowlog>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_database_error_logs
+   querying_database_slow_logs

api-ref/source/apis_recommended/managing_db_instances/index.rst

@@ -0,0 +1,34 @@
+:original_name: gaussdb_04_0003.html
+
+.. _gaussdb_04_0003:
+
+Managing DB Instances
+=====================
+
+-  :ref:`Creating a DB Instance <gaussdb_04_0004>`
+-  :ref:`Querying DB Instances <gaussdb_04_0005>`
+-  :ref:`Deleting a DB Instance <gaussdb_04_0007>`
+-  :ref:`Querying Details of a DB Instance <gaussdb_04_0006>`
+-  :ref:`Creating a Read Replica <gaussdb_04_0015>`
+-  :ref:`Deleting a Read Replica <gaussdb_04_0016>`
+-  :ref:`Changing a DB Instance Name <gaussdb_04_0018>`
+-  :ref:`Resetting a Database Password <gaussdb_04_0019>`
+-  :ref:`Changing DB Instance Specifications <gaussdb_04_0020>`
+-  :ref:`Changing the Collection Period of Monitoring by Seconds <updateinstancemonitor>`
+-  :ref:`Querying the Collection Period of Monitoring by Seconds <showinstancemonitorextend>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   creating_a_db_instance
+   querying_db_instances
+   deleting_a_db_instance
+   querying_details_of_a_db_instance
+   creating_a_read_replica
+   deleting_a_read_replica
+   changing_a_db_instance_name
+   resetting_a_database_password
+   changing_db_instance_specifications
+   changing_the_collection_period_of_monitoring_by_seconds
+   querying_the_collection_period_of_monitoring_by_seconds