dadrobna/distributed-database-middleware
1
0
Fork 0
forked from docs/distributed-database-middleware
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-11-01 02:40:22 +00:00
parent f88e86fb6e
commit 9c0208ed76
24 changed files with 196 additions and 314 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
api-ref/source/_static/images/en-us_image_0000001460419110.png → api-ref/source/_static/images/en-us_image_0000001685146158.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

0
api-ref/source/_static/images/en-us_image_0000001509858673.png → api-ref/source/_static/images/en-us_image_0000001733265073.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

0
api-ref/source/_static/images/en-us_image_0000001509539765.jpg → api-ref/source/_static/images/en-us_image_0000001733265081.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 136 KiB

After

Width:  |  Height:  |  Size: 136 KiB

2
api-ref/source/api_overview.rst
View File

@ -80,5 +80,3 @@ DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Monitoring | Monitoring slow query logs | This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Monitoring the read/write ratio (unavailable Soon) | This API is used to query reads and writes of a DDM instance in a specified time range. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/apis_recommended/ddm_accounts/managing_the_administrator_password.rst
View File

@ -88,7 +88,7 @@ Example Request
.. code-block:: text
POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user
PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/admin-user
{
"name" : "root",

4
api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst
View File

@ -98,7 +98,7 @@ Response Parameters
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| description | String | Description of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| created | String | Time when the DDM account is created. The format is yyyy-mm-ddThh:mm:ssZ. |
| created | Integer | Time when the DDM account is created |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| databases | Array of :ref:`GetUsersListdatabase <ddm_api_01_0043__response_getuserslistdatabase>` objects | Associated schemas |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
@ -158,7 +158,7 @@ OK
"status" : "RUNNING",
"base_authority" : [ "SELECT" ],
"description" : "Account",
"created" : "2019-10-30T11:01:24+0800",
"created" : 1686904661709,
"databases" : [ {
"name" : "test",
"description" : "Schema"

31
api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst
View File

@ -46,13 +46,15 @@ Request Parameters
.. table:: **Table 3** Request body parameters
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+=================================================================================================================================================================================================================================================+
| spec_code | Yes | String | Resource specification code of the new node class |
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| group_id | No | String | This parameter is not required if the instance has only one node group. Each instance has one node group by default. If you need to create multiple node groups, set this parameter to the ID of the group whose node class you want to change. |
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============+===========+=========+=================================================================================================================================================================================================================================================+
| spec_code | Yes | String | Resource specification code of the new node class |
+-------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| group_id | No | String | This parameter is not required if the instance has only one node group. Each instance has one node group by default. If you need to create multiple node groups, set this parameter to the ID of the group whose node class you want to change. |
+-------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_auto_pay | No | Boolean | The function has not been supported, and this field is reserved. |
+-------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -61,11 +63,13 @@ Response Parameters
.. table:: **Table 4** Response body parameters
========= ====== =======================================
Parameter Type Description
========= ====== =======================================
job_id String ID of the task for changing node class.
========= ====== =======================================
+-----------+--------+------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+==================================================================+
| job_id | String | ID of the task for changing node class. |
+-----------+--------+------------------------------------------------------------------+
| order_id | String | The function has not been supported, and this field is reserved. |
+-----------+--------+------------------------------------------------------------------+
**Status code: 400**
@ -111,7 +115,8 @@ ok
.. code-block::
{
"job_id" : "2x414788a5112333a02390e2eb0ea227"
"job_id" : "2x414788a5112333a02390e2eb0ea227",
"order_id" : ""
}
**Status code: 400**

115
api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis_recommended/ddm_instances/index.rst
View File

@ -24,7 +24,6 @@ DDM Instances
- :ref:`Querying DDM Engine Information <ddm_api_01_0015>`
- :ref:`Querying DDM Node Classes Available in an AZ <ddm_api_01_0016>`
- :ref:`Changing the Node Class of a DDM Instance <ddm_api_01_0017>`
- :ref:`This API is used to obtain information about the EIP bound to a DDM instance. <ddm_api_01_0092>`
.. toctree::
:maxdepth: 1
@ -49,4 +48,3 @@ DDM Instances
querying_ddm_engine_information
querying_ddm_node_classes_available_in_an_az
changing_the_node_class_of_a_ddm_instance
this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance.

6
api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst
View File

@ -121,9 +121,7 @@ Response Parameters
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| error_msg | String | Response message. This parameter is not returned if no abnormality occurs. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| node_status | String | Node status |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | Enterprise project ID |
| node_status | String | Node status For details, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of a tenant in a region |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
@ -186,7 +184,7 @@ OK
"core_count" : "2",
"ram_capacity" : "4",
"node_status" : "RUNNING",
"enterprise_project_id" : "0",
"project_id" : "055d9f4ee780d4d42f96c01c1bc3c50c",
"engine_version" : "3.0.8"
} ],

22
api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst
View File

@ -76,7 +76,7 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| access_port | String | Port for accessing the DDM instance |
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| node_status | String | Node status |
| node_status | String | Node status For details, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| core_count | String | Number of CPUs |
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
@ -86,7 +86,7 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | Enterprise project ID |
| order_id | String | The function has not been supported, and this field is reserved. |
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| engine_version | String | Engine version (core instance version) |
+-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
@ -103,13 +103,15 @@ Response Parameters
.. table:: **Table 4** GetDetailfNodesInfo
========= ====== ===================================
Parameter Type Description
========= ====== ===================================
status String Status of the DDM instance node
port String Port of the DDM instance node
ip String IP address of the DDM instance node
========= ====== ===================================
+-----------+--------+-----------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+===============================================================================================+
| status | String | Status of the DDM instance node For details, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------+--------+-----------------------------------------------------------------------------------------------+
| port | String | Port of the DDM instance node |
+-----------+--------+-----------------------------------------------------------------------------------------------+
| ip | String | IP address of the DDM instance node |
+-----------+--------+-----------------------------------------------------------------------------------------------+
**Status code: 400**
@ -170,7 +172,7 @@ OK
"core_count" : "2",
"ram_capacity" : "8",
"node_status" : "RUNNING",
"enterprise_project_id" : "0",
"project_id" : "070c071d8e80d58c2f42c0121b10cf9f",
"engine_version" : "3.0.6",
"admin_user_name" : "root"

37
api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst
View File

@ -50,20 +50,29 @@ Response Parameters
.. table:: **Table 3** Response body parameters
=============== ====== ==========================================
Parameter Type Description
=============== ====== ==========================================
status String Node status
name String Node name
node_id String Node ID
private_ip String Private IP address of the node
floating_ip String Floating IP address of the node
server_id String VM ID
subnet_name String Subnet name
datavolume_id String Data disk ID
res_subnet_ip String IP address provided by the resource subnet
systemvolume_id String System disk ID
=============== ====== ==========================================
+-----------------+--------+---------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+===========================================================================+
| status | String | Node status For details, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------+--------+---------------------------------------------------------------------------+
| name | String | Node name |
+-----------------+--------+---------------------------------------------------------------------------+
| node_id | String | Node ID |
+-----------------+--------+---------------------------------------------------------------------------+
| private_ip | String | Private IP address of the node |
+-----------------+--------+---------------------------------------------------------------------------+
| floating_ip | String | Floating IP address of the node |
+-----------------+--------+---------------------------------------------------------------------------+
| server_id | String | VM ID |
+-----------------+--------+---------------------------------------------------------------------------+
| subnet_name | String | Subnet name |
+-----------------+--------+---------------------------------------------------------------------------+
| datavolume_id | String | Data disk ID |
+-----------------+--------+---------------------------------------------------------------------------+
| res_subnet_ip | String | IP address provided by the resource subnet |
+-----------------+--------+---------------------------------------------------------------------------+
| systemvolume_id | String | System disk ID |
+-----------------+--------+---------------------------------------------------------------------------+
**Status code: 400**

19
api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst
View File

@ -83,14 +83,17 @@ Response Parameters
.. table:: **Table 5** NodeList
========= ====== ===========
Parameter Type Description
========= ====== ===========
port String Port
status String Node status
node_id String Node ID
ip String ip
========= ====== ===========
+-----------+--------+---------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+===========================================================================+
| port | String | Port |
+-----------+--------+---------------------------------------------------------------------------+
| status | String | Node status For details, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------+--------+---------------------------------------------------------------------------+
| node_id | String | Node ID |
+-----------+--------+---------------------------------------------------------------------------+
| ip | String | ip |
+-----------+--------+---------------------------------------------------------------------------+
**Status code: 400**

2
api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst
View File

@ -53,6 +53,8 @@ Request Parameters
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
| group_id | No | String | Group ID, which specifies the node group that is scaled out. This parameter must be specified if there are more than one node group. |
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
| is_auto_pay | No | Boolean | The function has not been supported, and this field is reserved. |
+-------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

167
api-ref/source/apis_recommended/ddm_instances/this_api_is_used_to_obtain_information_about_the_eip_bound_to_a_ddm_instance..rst
View File

File diff suppressed because it is too large Load Diff

13
api-ref/source/apis_recommended/monitoring/monitoring_slow_query_logs.rst
View File

@ -34,18 +34,15 @@ GET /v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================+
| curPage | Yes | String | Which page the server starts returning items. The start value cannot be less than **0**. |
| curPage | Yes | String | Which page the server starts returning items. The start value cannot be less than **1**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
| perPage | Yes | String | Number of records displayed on each page |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
| startDate | Yes | String | Start time in UTC, accurate to milliseconds |
| | | | |
| | | | The format is yyyy-mm-ddThh:mm:ssZ. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
| endDate | Yes | String | End time in UTC, accurate to milliseconds |
| | | | |
| | | | - The format is yyyy-mm-ddThh:mm:ssZ. |
| | | | - The interval between the start time and the end time must be no more than 7 days. |
| | | | The interval between the start time and the end time must be no more than 7 days. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
Request Parameters
@ -89,7 +86,7 @@ Response Parameters
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
| querySample | String | Syntax for executing the slow SQL statement |
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
| logTime | String | Time when the slow SQL statement starts to be executed The format is yyyy-mm-ddThh:mm:ssZ. |
| logTime | String | Time when the slow SQL statement starts to be executed |
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
| time | String | Time for a SQL statement to execute, accurate to milliseconds |
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
@ -125,9 +122,9 @@ Response Parameters
Example Request
---------------
.. code-block::
.. code-block:: text
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage=0&perPage=10&startDate=1687078800000&endDate=1687165200000
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
Example Response
----------------

2
api-ref/source/apis_recommended/schemas/deleting_a_schema.rst
View File

@ -18,7 +18,7 @@ None
URI
---
DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}
DELETE /v1/{project_id}/instances/{instance_id}/databases/{ddm_dbname}?delete_rds_data={delete_rds_data}
.. table:: **Table 1** Path parameters

4
api-ref/source/apis_recommended/schemas/querying_schemas.rst
View File

@ -40,7 +40,7 @@ GET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={li
| | | | |
| | | | The value must be a positive integer. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------+
| limit | No | Integer | A maximum schemas to be queried. |
| limit | No | Integer | Maximum schemas to be queried. |
| | | | |
| | | | Value range: 1 to 128. |
| | | | |
@ -93,7 +93,7 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| status | String | Schema status. For details about this parameter value, see :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| created | String | Time when the schema is created |
| created | Integer | Time when the schema is created |
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| used_rds | Array of :ref:`GetDatabaseUsedRds <ddm_api_01_0029__response_getdatabaseusedrds>` objects | RDS instances associated with the schema |
+-----------------------+-------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+

2
api-ref/source/appendix/obtaining_a_project_id.rst
View File

@ -60,7 +60,7 @@ Obtaining a Project ID from the Console
On the displayed page, view project IDs in the project list.
.. figure:: /_static/images/en-us_image_0000001509539765.jpg
.. figure:: /_static/images/en-us_image_0000001733265081.jpg
:alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs

49
api-ref/source/appendix/status_description.rst
View File

@ -10,21 +10,22 @@ DDM Instance Statuses
.. table:: **Table 1** DDM instance statuses
============== =============================================
Status Description
============== =============================================
CREATING The DDM instance is being created.
CREATEFAILED The DDM instance fails to be created.
RUNNING The DDM instance is running and available.
ERROR The DDM instance is faulty.
RESTARTING The DDM instance is being restarted.
RESIZING Class of the DDM instance fail to be changed.
GROWING A DDM instance is being scaled out.
REDUCING A DDM instance is being scaled in.
data_disk_full Disk space is full.
RESTORE A DDM instance is being restored.
BACKUP A DDM instance is being backed up.
============== =============================================
================= =============================================
Status Description
================= =============================================
CREATE The DDM instance is being created.
CREATEFAILED The DDM instance fails to be created.
RUNNING The DDM instance is running and available.
ERROR The DDM instance is faulty.
RESTARTING The DDM instance is being restarted.
RESIZING Class of the DDM instance fail to be changed.
GROWING A DDM instance is being scaled out.
REDUCING A DDM instance is being scaled in.
data_disk_full Disk space is full.
RESTORE A DDM instance is being restored.
BACKUP A DDM instance is being backed up.
SET_CONFIGURATION The instance parameters are being updated.
================= =============================================
DDM Schema Statuses
-------------------
@ -34,7 +35,7 @@ DDM Schema Statuses
================== ====================================
Status Description
================== ====================================
CREATING The schema is being created.
CREATE The schema is being created.
RUNNING The schema is running and available.
CREATEFAILED The schema fails to be created.
DELETING The schema is being deleted.
@ -42,3 +43,19 @@ DDM Schema Statuses
Scaling out failed The schema fails to be scaled out.
Rolling back The schema is being rolled back.
================== ====================================
DDM Node Statuses
-----------------
.. table:: **Table 3** Node statuses
=========== ========================================
Status Description
=========== ========================================
normal The node is running normally.
abnormal The node is abnormal.
creating The DDM instance is being created.
createfail The DDM instance fails to be created.
enlargefail The DDM instance fails to be scaled out.
resizing The node class is being changed.
=========== ========================================

2
api-ref/source/before_you_start/concepts.rst
View File

@ -26,7 +26,7 @@ Concepts
A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the 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_0000001509858673.png
.. figure:: /_static/images/en-us_image_0000001733265073.png
:alt: **Figure 1** Project isolating model
**Figure 1** Project isolating model

2
api-ref/source/calling_apis/returned_values.rst
View File

@ -23,7 +23,7 @@ Similar to a request, a response also has a header, for example, **Content-Type*
.. _ddm_api_01_0012__fig4865141011511:
.. figure:: /_static/images/en-us_image_0000001460419110.png
.. figure:: /_static/images/en-us_image_0000001685146158.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

16
api-ref/source/change_history.rst
View File

@ -7,8 +7,14 @@ Change History
.. table:: **Table 1** Document change history
=========== =========================================
Released On Description
=========== =========================================
2023-01-30 This issue is the first official release.
=========== =========================================
+-----------------------------------+-----------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+===============================================================================================+
| 2023-10-20 | Modified the following content: |
| | |
| | Added the **SET_CONFIGURATION** status in :ref:`Status Description <ddm_api_01_0064>`. |
| | |
| | Changed the **CREATING** status to **CREATE** in :ref:`Status Description <ddm_api_01_0064>`. |
+-----------------------------------+-----------------------------------------------------------------------------------------------+
| 2023-01-30 | This issue is the first official release. |
+-----------------------------------+-----------------------------------------------------------------------------------------------+

11
api-ref/source/conf.py
View File

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/distributed-database-middleware'
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 = '/distributed-database-middleware/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'database'
otcdocs_service_title = 'Distributed Database Middleware'
otcdocs_service_type = 'ddm'
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.