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_overview.rst

@@ -7,28 +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 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.                                                                                                                |
-+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| SQL statement concurrency control | Query, configure and delete concurrency control rules of SQL statements.                                                                                                                                           |
-+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Task center                       | 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/apis_recommended/backup_management/index.rst

@@ -9,6 +9,7 @@ Backup Management
 -  :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
@@ -18,3 +19,4 @@ Backup Management
    querying_backups
    querying_an_automated_backup_policy
    modifying_an_automated_backup_policy
+   deleting_a_manual_backup

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

@@ -12,7 +12,6 @@ This API is used to enable database proxy in ELB mode. Before using this API:
 
 -  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
 -  Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.
--  Database proxy is unavailable for DB instances in a DeC.
 
 URI
 ---
@@ -62,6 +61,8 @@ Request Parameters
    |                   |                 |                                                                                  | -  **readonly**                                                                                                                                                                                                                                              |
    +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    | nodes_read_weight | No              | Array of :ref:`NodesWeight <creategaussmysqlproxy__request_nodesweight>` objects | Read weight of the node.                                                                                                                                                                                                                                     |
+   |                   |                 |                                                                                  |                                                                                                                                                                                                                                                              |
+   |                   |                 |                                                                                  | If **proxy_mode** is set to **readonly**, you can assign weights only for read replicas.                                                                                                                                                                     |
    +-------------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 .. _creategaussmysqlproxy__request_nodesweight:

api-ref/source/apis_recommended/index.rst

@@ -14,7 +14,6 @@ APIs (Recommended)
 -  :ref:`Database Proxy <topic_300000006>`
 -  :ref:`Log Management <topic_300000007>`
 -  :ref:`Tag Management <topic_300000009>`
--  :ref:`SQL Statement Concurrency Control <topic_300000012>`
 -  :ref:`Task Center <gaussdb_04_0014>`
 
 .. toctree::
@@ -30,5 +29,4 @@ APIs (Recommended)
    database_proxy/index
    log_management/index
    tag_management/index
-   sql_statement_concurrency_control/index
    task_center/index

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

@@ -30,35 +30,29 @@ GET /v3/{project_id}/instances
 
 .. table:: **Table 2** Query parameters
 
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | Parameter       | Mandatory       | Type            | Description                                                                                                                                                                                                                                                                                              |
-   +=================+=================+=================+==========================================================================================================================================================================================================================================================================================================+
-   | id              | No              | String          | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | name            | No              | String          | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | type            | No              | String          | DB instance type to be queried. Currently, its value can only be **Cluster**.                                                                                                                                                                                                                            |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | datastore_type  | No              | String          | DB type. Currently, only gaussdb-mysql is supported.                                                                                                                                                                                                                                                     |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | vpc_id          | No              | String          | VPC ID.                                                                                                                                                                                                                                                                                                  |
-   |                 |                 |                 |                                                                                                                                                                                                                                                                                                          |
-   |                 |                 |                 | -  Method 1: Log in to VPC console and view the VPC ID in the VPC details.                                                                                                                                                                                                                               |
-   |                 |                 |                 | -  Method 2: See the "Querying VPCs" section in the *Virtual Private Cloud API Reference*.                                                                                                                                                                                                               |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | subnet_id       | No              | String          | Network ID of the subnet.                                                                                                                                                                                                                                                                                |
-   |                 |                 |                 |                                                                                                                                                                                                                                                                                                          |
-   |                 |                 |                 | -  Method 1: Log in to VPC console and click the target subnet on the **Subnets** page. You can view the network ID on the displayed page.                                                                                                                                                               |
-   |                 |                 |                 | -  Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the *Virtual Private Cloud API Reference*.                                                                                                                             |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | private_ip      | No              | String          | Private IP address.                                                                                                                                                                                                                                                                                      |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | offset          | No              | Integer         | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.                                                                    |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | limit           | No              | Integer         | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**.                                                                                                                                        |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | tags            | No              | String          | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship.                |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | Parameter      | Mandatory | Type    | Description                                                                                                                                                                                                                                                                                              |
+   +================+===========+=========+==========================================================================================================================================================================================================================================================================================================+
+   | id             | No        | String  | DB instance ID. The asterisk (``*``) is reserved for the system. If the DB instance ID starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the DB instance ID. The value cannot contain only asterisks (``*``). |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | name           | No        | String  | DB instance name. The asterisk (``*``) is reserved for the system. If the instance name starts with \*, it indicates that fuzzy match is performed based on the value following \*. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (``*``). |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | type           | No        | String  | DB instance type to be queried. Currently, its value can only be **Cluster**.                                                                                                                                                                                                                            |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | datastore_type | No        | String  | DB type. Currently, only gaussdb-mysql is supported.                                                                                                                                                                                                                                                     |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | vpc_id         | No        | String  | VPC ID.                                                                                                                                                                                                                                                                                                  |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | subnet_id      | No        | String  | Network ID of the subnet.                                                                                                                                                                                                                                                                                |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | private_ip     | No        | String  | Private IP address.                                                                                                                                                                                                                                                                                      |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | offset         | No        | Integer | Index offset. If **offset** is set to *N*, the resource query starts from the N+1 piece of data. The value is **0** by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.                                                                    |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | limit          | No        | Integer | Number of records to be queried. The default value is **100**. The value must be a positive integer. The minimum value is **1** and the maximum value is **100**.                                                                                                                                        |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   | tags           | No        | String  | Query based on the DB instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. To query DB instances with multiple tag keys and values, separate key-value pairs with commas (,). The key must be unique. Multiple keys are in AND relationship.                |
+   +----------------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Request Parameters
 ------------------

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/apis_recommended/quota_management/querying_resource_quotas.rst

@@ -132,7 +132,8 @@ Success.
        "availability_instance_quota" : 1,
        "availability_vcpus_quota" : 4,
        "availability_ram_quota" : 8
-     } ]
+     } ],
+     "total_count":1
    }
 
 Status Code

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

@@ -1,18 +0,0 @@
-:original_name: topic_300000012.html
-
-.. _topic_300000012:
-
-SQL Statement Concurrency Control
-=================================
-
--  :ref:`Configuring Concurrency Control Rules of SQL Statements <setsqlfilterrule>`
--  :ref:`Querying Concurrency Control Rules of SQL Statements <showsqlfilterrule>`
--  :ref:`Deleting Concurrency Control Rules of SQL Statements <deletesqlfilterrule>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   configuring_concurrency_control_rules_of_sql_statements
-   querying_concurrency_control_rules_of_sql_statements
-   deleting_concurrency_control_rules_of_sql_statements

api-ref/source/appendix/obtaining_a_project_id.rst

@@ -60,7 +60,7 @@ Obtain a Project ID from the Console
    On the **My Credentials** page, view project IDs in the project list.
 
 
-   .. figure:: /_static/images/en-us_image_0000001476990897.jpg
+   .. figure:: /_static/images/en-us_image_0000001828922089.png
       :alt: **Figure 1** Viewing project IDs
 
       **Figure 1** Viewing project IDs

api-ref/source/before_you_start/concepts.rst

@@ -28,7 +28,7 @@ Concepts
    Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.
 
 
-   .. figure:: /_static/images/en-us_image_0000001477110589.gif
+   .. figure:: /_static/images/en-us_image_0000001828921437.png
       :alt: **Figure 1** Project isolating model
 
       **Figure 1** Project isolating model

api-ref/source/conf.py

@@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/gaussdb-mysql'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'
 
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = 'internal'
+otcdocs_doc_link = '/gaussdb-mysql/api-ref/'
+otcdocs_doc_title = 'API Reference'
+otcdocs_doc_type = 'api-ref'
+otcdocs_service_category = 'database'
+otcdocs_service_title = 'GaussDB (for MySQL)'
+otcdocs_service_type = 'gaussdb_mysql'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

doc/requirements.txt

@@ -1,4 +1,11 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
+
 otcdocstheme # Apache-2.0
+
 # releasenotes
-reno>=3.1.0 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+
+otc-sphinx-directives>=0.1.0
+sphinx-minify>=0.0.1 # Apache-2.0
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools

doc/source/index.rst

@@ -1,3 +1,13 @@
-=============================================
-Welcome to the documentation of gaussdb-mysql
-=============================================
+GaussDB (for MySQL)
+===================
+
+GaussDB(for MySQL) is the latest generation enterprise-class distributed database. It is fully compatible with MySQL and provides high scalability and massive storage capacity. It uses a decoupled compute and storage architecture and supports up to 128 TB of storage. With GaussDB(for MySQL), there is no need to deal with sharding, and no need to worry about data loss. It combines the performance and availability of commercial databases with the cost-effectiveness of open source databases.
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. service_card::
+      :service_type: gaussdb_mysql
+      :umn: This document describes basic concepts, functions, key terms, and FAQs of GaussDB(for MySQL) and provides instructions for applying for and using GaussDB(for MySQL).
+      :api-ref: This document describes application programming interfaces (APIs) of GaussDB(for MySQL) and provides API parameter description and example values.
+