Update content

api-ref/source/api_overview.rst

@@ -1,32 +0,0 @@
-:original_name: gaussdb_02_0000.html
-
-.. _gaussdb_02_0000:
-
-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.                                                                                                                |
-+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Task center                   | Obtain task information about the task center.                                                                                                                                                                     |
-+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

api-ref/source/api_usage_guidelines/authentication.rst

@@ -1,54 +0,0 @@
-:original_name: gaussdb_03_0001.html
-
-.. _gaussdb_03_0001:
-
-Authentication
-==============
-
-Token authentication must be performed to call APIs.
-
-Authentication using tokens: General requests are authenticated using tokens.
-
-Token-based Authentication
---------------------------
-
-.. note::
-
-   The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
-
-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:
-
-::
-
-   Content-Type: application/json
-   X-Auth-Token: ABCDEFJ....

api-ref/source/api_usage_guidelines/index.rst

@@ -1,18 +0,0 @@
-:original_name: gaussdb_03_0000.html
-
-.. _gaussdb_03_0000:
-
-API Usage Guidelines
-====================
-
--  :ref:`Making an API Request <gaussdb_03_0005>`
--  :ref:`Authentication <gaussdb_03_0001>`
--  :ref:`Response <gaussdb_03_0006>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   making_an_api_request
-   authentication
-   response

api-ref/source/api_usage_guidelines/response.rst

@@ -1,62 +0,0 @@
-:original_name: gaussdb_03_0006.html
-
-.. _gaussdb_03_0006:
-
-Response
-========
-
-Status Code
------------
-
-After sending a request, you will receive a response, including the status code, response header, and response body.
-
-A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see :ref:`Status Codes <gaussdb_10_0002>`.
-
-For example, if status code **201** is returned for calling 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 is successful.
-
-Response Header
----------------
-
-Similar to a request, a response also has a header, for example, **Content-Type**.
-
-:ref:`Figure 1 <gaussdb_03_0006__fig4865141011511>` shows the response header for the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__. The **x-subject-token** header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
-
-.. _gaussdb_03_0006__fig4865141011511:
-
-.. 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
-
-(Optional) Response Body
-------------------------
-
-This part is optional. The body of a response is often returned in structured format as specified in the **Content-Type** header field. The response body transfers content except the response header.
-
-The following is part of the response body for the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__.
-
-.. code-block::
-
-   {
-       "token": {
-           "expires_at": "2019-02-13T06:52:13.855000Z",
-           "methods": [
-               "password"
-           ],
-           "catalog": [
-               {
-                   "endpoints": [
-                       {
-                           "region_id": "az-01",
-   ......
-
-If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
-
-.. code-block::
-
-   {
-       "error_code": "AS.0001",
-       "error_msg": "The format of message is error"
-   }
-
-In the response body, **error_code** is an error code, and **error_msg** provides information about the error.

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

@@ -1,22 +0,0 @@
-: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

@@ -1,26 +0,0 @@
-: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

@@ -1,32 +0,0 @@
-: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

@@ -1,16 +0,0 @@
-: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

@@ -1,34 +0,0 @@
-: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

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

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

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

@@ -1,20 +0,0 @@
-:original_name: gaussdb_04_0010.html
-
-.. _gaussdb_04_0010:
-
-Quota Management
-================
-
--  :ref:`Querying Resource Quotas <gaussdb_04_0011>`
--  :ref:`Configuring Resource Quotas <gaussdb_04_0012>`
--  :ref:`Modifying Resource Quotas <gaussdb_04_0013>`
--  :ref:`Querying the DB Instance Quotas of a Tenant <showgaussmysqlprojectquotas>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_resource_quotas
-   configuring_resource_quotas
-   modifying_resource_quotas
-   querying_the_db_instance_quotas_of_a_tenant

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

@@ -1,18 +0,0 @@
-:original_name: topic_300000009.html
-
-.. _topic_300000009:
-
-Tag Management
-==============
-
--  :ref:`Querying Resource Tags <listinstancetags>`
--  :ref:`Querying Project Tags <listprojecttags>`
--  :ref:`Adding or Deleting Tags in Batches <batchtagaction>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_resource_tags
-   querying_project_tags
-   adding_or_deleting_tags_in_batches