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-07-07 10:08:32 +00:00
parent bf5acdcb39
commit f88e86fb6e
25 changed files with 379 additions and 427 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -32,7 +32,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| x-auth-token | Yes | String | User token |
| x-auth-token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -57,16 +57,31 @@ Request Parameters
Response Parameters
-------------------
**Status code: default**
**Status code: 200**
No response parameters
**Status code: 400**
.. table:: **Table 4** Response body parameters
========== ====== =============
Parameter Type Description
========== ====== =============
error_code String Error code
error_msg String Error message
========== ====== =============
=============== ====== ==================
Parameter Type Description
=============== ====== ==================
errCode String Service error code
externalMessage String Error message
=============== ====== ==================
**Status code: 500**
.. table:: **Table 5** Response body parameters
=============== ====== ==================
Parameter Type Description
=============== ====== ==================
errCode String Service error code
externalMessage String Error message
=============== ====== ==================
Example Request
---------------
@ -83,17 +98,42 @@ Example Request
Example Response
----------------
**Status code: 200**
None
**Status code: 400**
bad request
.. code-block::
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}
**Status code: 500**
server error
.. code-block::
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}
Status Codes
------------
=========== =======================
=========== ============
Status Code Description
=========== =======================
=========== ============
200 OK
default Client or server error.
=========== =======================
400 bad request
500 server error
=========== ============
Error Codes
-----------

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

@ -18,7 +18,7 @@ None
URI
---
GET /v1/{project_id}/instances/{instance_id}/users
GET /v1/{project_id}/instances/{instance_id}/users?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -85,27 +85,23 @@ Response Parameters
.. table:: **Table 5** GetUsersListDetailResponses
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+===============================================================================================+=============================================================================================================================+
| name | String | Username of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| status | String | Status of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| base_authority | Array of strings | Basic permissions of the DDM account. |
| | | |
| | | The value can be **CREATE**, **DROP**, **ALTER**, **INDEX**, **INSERT**, **DELETE**, **UPDATE**, or **SELECT**. |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| extend_authority | Array of strings | Extended permissions of the DDM account. This parameter is unavailable since August 2021 and was deleted in September 2021. |
| | | |
| | | The value can be **fulltableDelete**, **fulltableSelect**, or **fulltableUpdate**. |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| description | String | Description of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| created | Long | Time when the DDM account is created |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| databases | Array of :ref:`GetUsersListdatabase <ddm_api_01_0043__response_getuserslistdatabase>` objects | Associated schemas |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+===============================================================================================+=================================================================================================================+
| name | String | Username of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| status | String | Status of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| base_authority | Array of strings | Basic permissions of the DDM account. |
| | | |
| | | The value can be **CREATE**, **DROP**, **ALTER**, **INDEX**, **INSERT**, **DELETE**, **UPDATE**, or **SELECT**. |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| description | String | Description of the DDM account |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| created | String | Time when the DDM account is created. The format is yyyy-mm-ddThh:mm:ssZ. |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| databases | Array of :ref:`GetUsersListdatabase <ddm_api_01_0043__response_getuserslistdatabase>` objects | Associated schemas |
+-----------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
.. _ddm_api_01_0043__response_getuserslistdatabase:
@ -164,7 +160,7 @@ OK
"description" : "Account",
"created" : "2019-10-30T11:01:24+0800",
"databases" : [ {
"name" : "zhxtest",
"name" : "test",
"description" : "Schema"
} ]
} ],

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

@ -96,7 +96,9 @@ Example Request
POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{username}/password
{
"password" : "GaussTest_234"
"success": true,
"instance_id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",
"user_name" : "ddmtest"
}
Example Response

58
api-ref/source/apis_recommended/ddm_accounts/validating_password_strength.rst
View File

@ -31,7 +31,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| x-auth-token | Yes | String | User token |
| x-auth-token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -57,16 +57,27 @@ Response Parameters
| is_weak_password | Boolean | Whether the password is a weak password. The value can be: **true**: indicating that the password is a weak password. Such a password is not recommended. **false**: indicating that the password is not a weak password. Such a password is recommended. |
+------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: default**
**Status code: 400**
.. table:: **Table 5** Response body parameters
========== ====== =============
Parameter Type Description
========== ====== =============
error_code String Error code
error_msg String Error message
========== ====== =============
=============== ====== ==================
Parameter Type Description
=============== ====== ==================
errCode String Service error code
externalMessage String Error message
=============== ====== ==================
**Status code: 500**
.. table:: **Table 6** Response body parameters
=============== ====== ==================
Parameter Type Description
=============== ====== ==================
errCode String Service error code
externalMessage String Error message
=============== ====== ==================
Example Request
---------------
@ -92,15 +103,38 @@ OK
"is_weak_password" : true
}
**Status code: 400**
bad request
.. code-block::
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}
**Status code: 500**
server error
.. code-block::
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}
Status Codes
------------
=========== =======================
=========== ============
Status Code Description
=========== =======================
=========== ============
200 OK
default Client or server error.
=========== =======================
400 bad request
500 server error
=========== ============
Error Codes
-----------

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

@ -67,16 +67,27 @@ Response Parameters
job_id String ID of the task for changing node class.
========= ====== =======================================
**Status code: default**
**Status code: 400**
.. table:: **Table 5** Response body parameters
=============== ====== =============
=============== ====== ==================
Parameter Type Description
=============== ====== =============
errCode String Error code
=============== ====== ==================
errCode String Service error code
externalMessage String Error message
=============== ====== =============
=============== ====== ==================
**Status code: 500**
.. table:: **Table 6** Response body parameters
=============== ====== ==================
Parameter Type Description
=============== ====== ==================
errCode String Service error code
externalMessage String Error message
=============== ====== ==================
Example Request
---------------
@ -86,7 +97,7 @@ Example Request
PUT https://{endpoint}/v3/{project_id}/instances/{instance_id}/flavor
{
"spec_code" : "ddm.c6.4xlarge.2",
"spec_code" : "ddm.8xlarge.2",
"group_id" : "3e5a9063d3b84729b0a3310fad3a0942gr09"
}
@ -103,15 +114,38 @@ ok
"job_id" : "2x414788a5112333a02390e2eb0ea227"
}
**Status code: 400**
bad request
.. code-block::
{
"externalMessage" : "Parameter error.",
"errCode" : "DBS.280001"
}
**Status code: 500**
server error
.. code-block::
{
"externalMessage" : "Server failure.",
"errCode" : "DBS.200412"
}
Status Codes
------------
=========== =======================
=========== ============
Status Code Description
=========== =======================
200 ok
default Client or server error.
=========== =======================
=========== ============
200 OK
400 bad request
500 server error
=========== ============
Error Codes
-----------

15
api-ref/source/apis_recommended/ddm_instances/modifying_the_read_policy_of_the_associated_db_instance.rst
View File

@ -37,18 +37,21 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request body parameters
+-------------+-----------+--------+---------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============+===========+========+===============================================================+
| read_weight | Yes | Object | Read weights of the primary DB instance and its read replicas |
+-------------+-----------+--------+---------------------------------------------------------------+
+-----------------+-----------------+----------------------+---------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+======================+===============================================================+
| read_weight | Yes | Map<String, Integer> | Read weights of the primary DB instance and its read replicas |
| | | | |
| | | | - key: DB instance ID |
| | | | - value: read weight parameter |
+-----------------+-----------------+----------------------+---------------------------------------------------------------+
Response Parameters
-------------------

16
api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst
View File

@ -18,7 +18,7 @@ None
URI
---
GET /v2/{project_id}/engines
GET /v2/{project_id}/engines?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -133,7 +133,7 @@ Example Request
.. code-block:: text
GET https://{endpoint}/v2/{project_id}/engines
GET https://{endpoint}/v2/{project_id}/engines?offset={offset}&limit={limit}
Example Response
----------------
@ -150,17 +150,17 @@ OK
"name" : "ddm",
"version" : "3.0.8",
"supportAzs" : [ {
"code" : "az1xahz",
"name" : "az1xahz",
"code" : "az1",
"name" : "az1",
"favored" : false
}, {
"code" : "az2xahz",
"name" : "az2xahz",
"code" : "az2",
"name" : "az2",
"favored" : true
} ]
} ],
"offset" : "0",
"limit" : "128",
"offset" : 0,
"limit" : 128,
"total" : 1
}

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

@ -18,7 +18,7 @@ None
URI
---
GET /v1/{project_id}/instances
GET /v1/{project_id}/instances?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -176,7 +176,7 @@ OK
"name" : "ddm-36c7",
"created" : "2021-12-14T07:46:22+0000",
"updated" : "2021-12-14T10:11:22+0000",
"available_zone" : "az1xahz",
"available_zone" : "az1",
"vpc_id" : "1d9441c5-1a4b-431d-9edb-bf3564a83e74",
"subnet_id" : "20c2d83c-755b-42a2-846a-4688eb35d1a7",
"security_group_id" : "fbdff89d-32fe-45a4-832b-115ac4bfaac9",

202
api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst
View File

File diff suppressed because it is too large Load Diff

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

@ -160,7 +160,7 @@ OK
"name" : "ddm2-test",
"created" : "2021-11-09T03:30:01+0000",
"updated" : "2021-12-15T09:12:58+0000",
"available_zone" : "az1xahz",
"available_zone" : "az1",
"vpc_id" : "cfaa4024-0603-4aba-81d4-2203b4ad26fb",
"subnet_id" : "48f270ef-af70-4ad9-bb1c-c28dd5b37f93",
"security_group_id" : "bc28ef93-0083-4652-bce6-381e14284db6",

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

@ -18,7 +18,7 @@ None
URI
---
GET /v1/{project_id}/instances/{instance_id}/nodes
GET /v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -119,7 +119,7 @@ Example Request
.. code-block:: text
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes?offset={offset}&limit={limit}
Example Response
----------------
@ -137,7 +137,7 @@ OK
"node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
"ip" : "192.168.0.160"
} ],
"offset" : "DBS.280001",
"offset" : 0,
"limit" : 128,
"total" : 1
}

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

@ -18,7 +18,7 @@ None
URI
---
GET /v3/{project_id}/instances/{instance_id}/configurations
GET /v3/{project_id}/instances/{instance_id}/configurations?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -148,8 +148,8 @@ OK
"data_type" : "integer",
"description" : "Maximum size of the temporary table."
} ],
"offset" : "0",
"limit" : "128",
"offset" : 0,
"limit" : 128,
"total" : 22
}

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

@ -37,7 +37,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -45,6 +45,10 @@ Request Parameters
Response Parameters
-------------------
**Status code: 200**
No response parameters
**Status code: 400**
.. table:: **Table 3** Response body parameters

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

@ -124,7 +124,7 @@ ok
{
"instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
"instanceName" : "BUG-ddm-fb88-test",
"instanceName" : "ddm-test",
"jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
}

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

@ -18,7 +18,7 @@ None
URI
---
GET /v2/{project_id}/instances/{instance_id}/slowlog
GET /v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
.. table:: **Table 1** Path parameters
@ -31,17 +31,22 @@ GET /v2/{project_id}/instances/{instance_id}/slowlog
.. table:: **Table 2** Query parameters
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+=============================================================================================================================+
| curPage | Yes | String | Which page the server starts returning items. The start value cannot be less than **0**. |
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| perPage | Yes | String | Number of records displayed on each page |
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| startDate | Yes | String | Start time in UTC, accurate to milliseconds |
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+
| endDate | Yes | String | End time in UTC, accurate to milliseconds The interval between the start time and the end time must be no more than 7 days. |
+-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================+
| curPage | Yes | String | Which page the server starts returning items. The start value cannot be less than **0**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
| 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. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -51,7 +56,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -84,7 +89,7 @@ Response Parameters
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
| querySample | String | Syntax for executing the slow SQL statement |
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
| logTime | String | Time when the slow SQL statement starts to be executed |
| logTime | String | Time when the slow SQL statement starts to be executed The format is yyyy-mm-ddThh:mm:ssZ. |
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
| time | String | Time for a SQL statement to execute, accurate to milliseconds |
+--------------+--------+---------------------------------------------------------------------------------------------------------------+
@ -120,9 +125,9 @@ Response Parameters
Example Request
---------------
.. code-block:: text
.. code-block::
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate}
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/slowlog?curPage=0&perPage=10&startDate=1687078800000&endDate=1687165200000
Example Response
----------------

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

@ -56,7 +56,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================+
| X-Auth-Token | Yes | String | User token |
| X-Auth-Token | Yes | String | User token. |
| | | | |
| | | | It can be obtained by calling an IAM API. The value of **X-Subject-Token** in the response header is the user token. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
@ -64,6 +64,10 @@ Request Parameters
Response Parameters
-------------------
**Status code: 200**
No response parameters
**Status code: 400**
.. table:: **Table 4** Response body parameters

16
api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst
View File

@ -18,7 +18,7 @@ None
URI
---
GET /v1/{project_id}/instances/{instance_id}/rds
GET /v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -136,7 +136,7 @@ Example Request
.. code-block:: text
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/rds?offset={offset}&limit={limit}
Example Response
----------------
@ -152,25 +152,25 @@ OK
"id" : "c6f68fed9e74478c8679479a07d7d568in01",
"projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c",
"status" : "normal",
"name" : "test-ddm-no-delete-test01-00",
"name" : "test-ddm",
"engineName" : "mysql",
"engineSoftwareVersion" : 5.7,
"engineSoftwareVersion" : "5.7",
"privateIp" : "192.168.23.97",
"mode" : "Ha",
"port" : 3306,
"azCode" : "az1xahzaz1xahz",
"azCode" : "az1az1",
"timeZone" : "UTC+08: 00"
}, {
"id" : "337e2598c2a64cb5935079f85996731din01",
"projectId" : "055d9f4ee780d4d42f96c01c1bc3c50c",
"status" : "normal",
"name" : "test-ddm-no-delete-test01",
"name" : "test-ddm",
"engineName" : "mysql",
"engineSoftwareVersion" : 5.7,
"engineSoftwareVersion" : "5.7",
"privateIp" : "192.168.23.221",
"mode" : "Ha",
"port" : 3306,
"azCode" : "az1xahzaz1xahz",
"azCode" : "az1az1",
"timeZone" : "UTC+08: 00"
} ],
"offset" : 0,

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

@ -234,7 +234,7 @@ OK
"shard_number" : 8,
"shard_unit" : 8,
"dataVips" : [ {
"id" : "192.168.185.97:5066"
"192.168.185.97:5066"
} ],
"used_rds" : [ {
"id" : "e70a82534a364492b795c5080e3a1591in01",

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

@ -18,7 +18,7 @@ None
URI
---
GET /v1/{project_id}/instances/{instance_id}/databases
GET /v1/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}
.. table:: **Table 1** Path parameters
@ -155,20 +155,20 @@ OK
.. code-block::
{
"databases" : [ {
"status" : "RUNNING",
"created" : "1642063713625",
"name" : "mytestdb170",
"shard_mode" : "cluster",
"shard_number" : "8",
"shard_unit" : "8",
"used_rds" : [ {
"id" : "c6f68fed9e74478c8679479a07d7d568in01",
"status" : "normal",
"name" : "rds-test"
} ]
} ],
"total" : 172
"databases": [{
"status": "RUNNING",
"created": 1642063713625,
"name": "mytestdb170",
"shard_mode": "cluster",
"shard_number": 8,
"shard_unit": 8,
"used_rds": [{
"id": "c6f68fed9e74478c8679479a07d7d568in01",
"status": "normal",
"name": "rds-test"
}]
}],
"total": 172
}
**Status code: 400**

14
api-ref/source/apis_unavailable_soon/index.rst
View File

@ -1,14 +0,0 @@
:original_name: ddm_api_02_0001.html
.. _ddm_api_02_0001:
APIs (Unavailable Soon)
=======================
- :ref:`Monitoring the Read/Write Ratio <ddm_api_01_0091>`
.. toctree::
:maxdepth: 1
:hidden:
monitoring_the_read_write_ratio

175
api-ref/source/apis_unavailable_soon/monitoring_the_read_write_ratio.rst
View File

File diff suppressed because it is too large Load Diff

4
api-ref/source/appendix/index.rst
View File

@ -8,7 +8,7 @@ Appendix
- :ref:`Abnormal Request Results <ddm_api_01_0059>`
- :ref:`Status Codes <ddm_api_01_0060>`
- :ref:`Error Codes <ddm_api_01_0061>`
- :ref:`Instance Specifications <ddm_api_01_0062>`
- :ref:`Node Classes <ddm_api_01_0062>`
- :ref:`Obtaining a Project ID <ddm_api_01_0063>`
- :ref:`Status Description <ddm_api_01_0064>`
@ -19,6 +19,6 @@ Appendix
abnormal_request_results
status_codes
error_codes
instance_specifications
node_classes
obtaining_a_project_id
status_description

20
api-ref/source/appendix/instance_specifications.rst
View File

@ -1,20 +0,0 @@
:original_name: ddm_api_01_0062.html
.. _ddm_api_01_0062:
Instance Specifications
=======================
For details about DDM instance classes, see :ref:`Table 1 <ddm_api_01_0062__table107452419227>`. The classes vary depending on actual situations.
.. _ddm_api_01_0062__table107452419227:
.. table:: **Table 1** Supported DDM instance specifications
================== ===== =========== ============
Specification Code vCPUs Memory (GB) Architecture
================== ===== =========== ============
ddm.c6.2xlarge.2 8 16 X86
ddm.c6.4xlarge.2 16 32 X86
ddm.c6.8xlarge.2 32 64 X86
================== ===== =========== ============

18
api-ref/source/appendix/node_classes.rst Normal file
View File

@ -0,0 +1,18 @@
:original_name: ddm_api_01_0062.html
.. _ddm_api_01_0062:
Node Classes
============
DDM node classes are listed in the following table and vary according to actual situations.
.. table:: **Table 1** Supported DDM node classes
================== ===== =========== ============
Specification Code vCPUs Memory (GB) Architecture
================== ===== =========== ============
ddm.2xlarge.2 8 16 x86
ddm.4xlarge.2 16 32 x86
ddm.8xlarge.2 32 64 x86
================== ===== =========== ============

1
api-ref/source/index.rst
View File

@ -9,6 +9,5 @@ Distributed Database Middleware - API Reference
api_overview
calling_apis/index
apis_recommended/index
apis_unavailable_soon/index
appendix/index
change_history