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-02-15 10:37:50 +00:00 committed by vladimirhasko
parent 7964db4ee3
commit f7b22806e6
62 changed files with 7286 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
api-ref/source/_static/images/en-us_image_0000001460419110.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001509539765.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 136 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001509858673.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

84
api-ref/source/api_overview.rst Normal file
View File

@ -0,0 +1,84 @@
:original_name: ddm_api_01_0007.html
.. _ddm_api_01_0007:
API Overview
============
DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including creating DDM instances and schemas.
.. table:: **Table 1** API description
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Type | Subtype | Description |
+=================================+=========================================================+=================================================================================================================================================================================================+
| APIs for managing DDM instances | Creating a DDM instance | This API is used to create a DDM instance. |
| | | |
| | | DDM runs in VPCs. Before you apply for a DDM instance, ensure that a VPC is available and a subnet and security group have been configured. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying DDM instances | This API is used to query DDM instances. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying details of a DDM instance | This API is used to query details about a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Modifying the name of a DDM instance | This API is used to modify the name of an existing DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Modifying the security group of a DDM instance | This API is used to modify the security group of a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Deleting a DDM instance | This API is used to delete a DDM instance to release all its resources. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Restarting a DDM instance | This API is used to restart a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Reloading table data | This API is used to reload table data of the required DDM instance for cross-region DR. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Scaling out a DDM instance | This API is used to add nodes to a specified DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Scaling in a DDM instance | This API is used to remove nodes from a specified DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Modifying the read policy of the associated DB instance | This API is used to modify the read policy of the DB instance associated with a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Synchronizing data node information | This API is used to synchronize configuration information of all data nodes that are associated with the current DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying nodes of a DDM instance | This API is used to query nodes of a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying details of a DDM instance node | This API is used to query details of a DDM instance node. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying parameters of a specified DDM instance | This API is used to query parameters of a specified DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Modifying parameters of a DDM instance | This API is used to modify parameters of a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying DDM engine information | This API is used to query information about DDM engine. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying DDM node classes available in an AZ | This API is used to query DDM node classes available in an AZ. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Changing the node class of a DDM Instance | This API is used to change the node class of a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| APIs for managing schemas | Creating a schema | This API is used to create a schema. |
| | | |
| | | Before creating a schema, ensure that there is an RDS instance available and that the instance is running properly and not associated with any DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying schemas of a DDM instance | This API is used to query schemas of a DDM instance. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying details of a schema | This API is used to query details about a schema. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Deleting a schema | This API is used to delete a schema to release all its resources. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying DB instances available for creating a schema | This API is used to query DB instances that can be used for creating a schema. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| APIs for managing DDM accounts | Creating a DDM account | This API is used to create a DDM account. DDM accounts are used to connect to and manage schemas. One DDM account can be associated with multiple schemas. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Querying DDM accounts | This API is used to query DDM accounts. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Modifying a DDM account | This API is used to modify the permissions and associated schemas of a DDM account. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Deleting a DDM account | This API is used to delete a DDM account. This operation will also disassociate the account from schemas if any. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Resetting the password of a DDM account | This API is used to reset the password of a DDM account. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Managing the administrator password | If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the administrator password. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | Validating password strength | This API is used to validate whether an instance password is a weak password. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

219
api-ref/source/apis_recommended/ddm_accounts/creating_a_ddm_account.rst Normal file
View File

File diff suppressed because it is too large Load Diff

137
api-ref/source/apis_recommended/ddm_accounts/deleting_a_ddm_account.rst Normal file
View File

File diff suppressed because it is too large Load Diff

26
api-ref/source/apis_recommended/ddm_accounts/index.rst Normal file
View File

@ -0,0 +1,26 @@
:original_name: ddm_api_01_0041.html
.. _ddm_api_01_0041:
DDM Accounts
============
- :ref:`Creating a DDM Account <ddm_07_0001>`
- :ref:`Querying DDM Accounts <ddm_api_01_0043>`
- :ref:`Modifying a DDM Account <ddm_api_01_0044>`
- :ref:`Deleting a DDM Account <ddm_api_01_0045>`
- :ref:`Resetting the Password of a DDM Account <ddm_api_01_0088>`
- :ref:`Managing the Administrator Password <ddm_api_01_0101>`
- :ref:`Validating Password Strength <ddm_api_01_0102>`
.. toctree::
:maxdepth: 1
:hidden:
creating_a_ddm_account
querying_ddm_accounts
modifying_a_ddm_account
deleting_a_ddm_account
resetting_the_password_of_a_ddm_account
managing_the_administrator_password
validating_password_strength

101
api-ref/source/apis_recommended/ddm_accounts/managing_the_administrator_password.rst Normal file
View File

File diff suppressed because it is too large Load Diff

198
api-ref/source/apis_recommended/ddm_accounts/modifying_a_ddm_account.rst Normal file
View File

File diff suppressed because it is too large Load Diff

211
api-ref/source/apis_recommended/ddm_accounts/querying_ddm_accounts.rst Normal file
View File

File diff suppressed because it is too large Load Diff

151
api-ref/source/apis_recommended/ddm_accounts/resetting_the_password_of_a_ddm_account.rst Normal file
View File

File diff suppressed because it is too large Load Diff

108
api-ref/source/apis_recommended/ddm_accounts/validating_password_strength.rst Normal file
View File

File diff suppressed because it is too large Load Diff

124
api-ref/source/apis_recommended/ddm_instances/changing_the_node_class_of_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

319
api-ref/source/apis_recommended/ddm_instances/creating_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

160
api-ref/source/apis_recommended/ddm_instances/deleting_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

50
api-ref/source/apis_recommended/ddm_instances/index.rst Normal file
View File

@ -0,0 +1,50 @@
:original_name: ddm_api_01_0014.html
.. _ddm_api_01_0014:
DDM Instances
=============
- :ref:`Creating a DDM instance <ddm_04_0001>`
- :ref:`Querying DDM Instances <ddm_api_01_0018>`
- :ref:`Querying Details of a DDM Instance <ddm_api_01_0019>`
- :ref:`Modifying the Name of a DDM Instance <ddm_api_01_0020>`
- :ref:`Modifying the Security Group of a DDM Instance <ddm_api_01_0021>`
- :ref:`Deleting a DDM Instance <ddm_api_01_0022>`
- :ref:`Restarting a DDM Instance <ddm_api_01_0023>`
- :ref:`Reloading Table Data <ddm_api_01_0024>`
- :ref:`Scaling Out a DDM Instance <ddm_api_01_0025>`
- :ref:`Scaling in a DDM instance <ddm_api_01_0026>`
- :ref:`Modifying the Read Policy of the Associated DB Instance <ddm_api_01_0080>`
- :ref:`Synchronizing Data Node Information <ddm_api_01_0081>`
- :ref:`Querying Nodes of a DDM Instance <ddm_api_01_0082>`
- :ref:`Querying Details of a DDM Instance Node <ddm_api_01_0083>`
- :ref:`Querying Parameters of a Specified DDM Instance <ddm_api_01_0084>`
- :ref:`Modifying Parameters of a DDM Instance <ddm_api_01_0085>`
- :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>`
.. toctree::
:maxdepth: 1
:hidden:
creating_a_ddm_instance
querying_ddm_instances
querying_details_of_a_ddm_instance
modifying_the_name_of_a_ddm_instance
modifying_the_security_group_of_a_ddm_instance
deleting_a_ddm_instance
restarting_a_ddm_instance
reloading_table_data
scaling_out_a_ddm_instance
scaling_in_a_ddm_instance
modifying_the_read_policy_of_the_associated_db_instance
synchronizing_data_node_information
querying_nodes_of_a_ddm_instance
querying_details_of_a_ddm_instance_node
querying_parameters_of_a_specified_ddm_instance
modifying_parameters_of_a_ddm_instance
querying_ddm_engine_information
querying_ddm_node_classes_available_in_an_az
changing_the_node_class_of_a_ddm_instance

265
api-ref/source/apis_recommended/ddm_instances/modifying_parameters_of_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

156
api-ref/source/apis_recommended/ddm_instances/modifying_the_name_of_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

153
api-ref/source/apis_recommended/ddm_instances/modifying_the_read_policy_of_the_associated_db_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

148
api-ref/source/apis_recommended/ddm_instances/modifying_the_security_group_of_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

201
api-ref/source/apis_recommended/ddm_instances/querying_ddm_engine_information.rst Normal file
View File

File diff suppressed because it is too large Load Diff

235
api-ref/source/apis_recommended/ddm_instances/querying_ddm_instances.rst Normal file
View File

File diff suppressed because it is too large Load Diff

264
api-ref/source/apis_recommended/ddm_instances/querying_ddm_node_classes_available_in_an_az.rst Normal file
View File

File diff suppressed because it is too large Load Diff

217
api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

154
api-ref/source/apis_recommended/ddm_instances/querying_details_of_a_ddm_instance_node.rst Normal file
View File

File diff suppressed because it is too large Load Diff

179
api-ref/source/apis_recommended/ddm_instances/querying_nodes_of_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

190
api-ref/source/apis_recommended/ddm_instances/querying_parameters_of_a_specified_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

126
api-ref/source/apis_recommended/ddm_instances/reloading_table_data.rst Normal file
View File

File diff suppressed because it is too large Load Diff

172
api-ref/source/apis_recommended/ddm_instances/restarting_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

167
api-ref/source/apis_recommended/ddm_instances/scaling_in_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

185
api-ref/source/apis_recommended/ddm_instances/scaling_out_a_ddm_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

140
api-ref/source/apis_recommended/ddm_instances/synchronizing_data_node_information.rst Normal file
View File

File diff suppressed because it is too large Load Diff

20
api-ref/source/apis_recommended/index.rst Normal file
View File

@ -0,0 +1,20 @@
:original_name: ddm_api_02_0000.html
.. _ddm_api_02_0000:
APIs (Recommended)
==================
- :ref:`DDM Instances <ddm_api_01_0014>`
- :ref:`Schemas <ddm_api_01_0027>`
- :ref:`DDM Accounts <ddm_api_01_0041>`
- :ref:`Monitoring <ddm_api_01_0089>`
.. toctree::
:maxdepth: 1
:hidden:
ddm_instances/index
schemas/index
ddm_accounts/index
monitoring/index

14
api-ref/source/apis_recommended/monitoring/index.rst Normal file
View File

@ -0,0 +1,14 @@
:original_name: ddm_api_01_0089.html
.. _ddm_api_01_0089:
Monitoring
==========
- :ref:`Monitoring Slow Query Logs <ddm_api_01_0090>`
.. toctree::
:maxdepth: 1
:hidden:
monitoring_slow_query_logs

186
api-ref/source/apis_recommended/monitoring/monitoring_slow_query_logs.rst Normal file
View File

File diff suppressed because it is too large Load Diff

231
api-ref/source/apis_recommended/schemas/creating_a_schema.rst Normal file
View File

File diff suppressed because it is too large Load Diff

151
api-ref/source/apis_recommended/schemas/deleting_a_schema.rst Normal file
View File

File diff suppressed because it is too large Load Diff

22
api-ref/source/apis_recommended/schemas/index.rst Normal file
View File

@ -0,0 +1,22 @@
:original_name: ddm_api_01_0027.html
.. _ddm_api_01_0027:
Schemas
=======
- :ref:`Creating a Schema <ddm_16_0001>`
- :ref:`Querying Schemas <ddm_api_01_0029>`
- :ref:`Querying Details of a Schema <ddm_api_01_0030>`
- :ref:`Deleting a Schema <ddm_api_01_0031>`
- :ref:`Querying DB Instances Available for Creating a Schema <ddm_api_01_0100>`
.. toctree::
:maxdepth: 1
:hidden:
creating_a_schema
querying_schemas
querying_details_of_a_schema
deleting_a_schema
querying_db_instances_available_for_creating_a_schema

215
api-ref/source/apis_recommended/schemas/querying_db_instances_available_for_creating_a_schema.rst Normal file
View File

File diff suppressed because it is too large Load Diff

283
api-ref/source/apis_recommended/schemas/querying_details_of_a_schema.rst Normal file
View File

File diff suppressed because it is too large Load Diff

208
api-ref/source/apis_recommended/schemas/querying_schemas.rst Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -0,0 +1,14 @@
: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 Normal file
View File

File diff suppressed because it is too large Load Diff

29
api-ref/source/appendix/abnormal_request_results.rst Normal file
View File

@ -0,0 +1,29 @@
:original_name: ddm_api_01_0059.html
.. _ddm_api_01_0059:
Abnormal Request Results
========================
Abnormal Response
-----------------
.. table:: **Table 1** Parameter description
+-----------------+--------+---------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========+=====================================================================================================================+
| errCode | String | Returned error code when a task submission exception occurs. For details, see :ref:`Error Codes <ddm_api_01_0061>`. |
+-----------------+--------+---------------------------------------------------------------------------------------------------------------------+
| externalMessage | String | Description of the error returned when a task submission exception occurs. |
+-----------------+--------+---------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
.. code-block:: text
{
"errCode": "DBS.300101",
"externalMessage": "Failed to delete the schema"
}

242
api-ref/source/appendix/error_codes.rst Normal file
View File

File diff suppressed because it is too large Load Diff

24
api-ref/source/appendix/index.rst Normal file
View File

@ -0,0 +1,24 @@
:original_name: ddm_api_01_0058.html
.. _ddm_api_01_0058:
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:`Obtaining a Project ID <ddm_api_01_0063>`
- :ref:`Status Description <ddm_api_01_0064>`
.. toctree::
:maxdepth: 1
:hidden:
abnormal_request_results
status_codes
error_codes
instance_specifications
obtaining_a_project_id
status_description

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

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

66
api-ref/source/appendix/obtaining_a_project_id.rst Normal file
View File

@ -0,0 +1,66 @@
:original_name: ddm_api_01_0063.html
.. _ddm_api_01_0063:
Obtaining a Project ID
======================
Scenarios
---------
When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first Two methods are available:
- :ref:`Obtaining the Project ID by Calling an API <ddm_api_01_0063__section85791974381>`
- :ref:`Obtaining a Project ID from the Console <ddm_api_01_0063__section153711445316>`
.. _ddm_api_01_0063__section85791974381:
Obtaining the Project ID by Calling an API
------------------------------------------
The API used to obtain a project ID is **GET https://{Endpoint}/v3/projects**. **{Endpoint}** is the IAM endpoint and can be obtained from `Regions and Endpoints <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. For details about API authentication, see :ref:`Authentication <ddm_api_01_0011>`.
The following is an example response. **id** indicates the project ID.
.. code-block::
{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14e684b",
"name": "project_name",
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
},
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}
.. _ddm_api_01_0063__section153711445316:
Obtaining a Project ID from the Console
---------------------------------------
#. Sign up and log in to the management console.
#. Move your pointer over the username and select **My Credentials** in the displayed drop-down list.
On the displayed page, view project IDs in the project list.
.. figure:: /_static/images/en-us_image_0000001509539765.jpg
:alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs

60
api-ref/source/appendix/status_codes.rst Normal file
View File

@ -0,0 +1,60 @@
:original_name: ddm_api_01_0060.html
.. _ddm_api_01_0060:
Status Codes
============
Normal
------
:ref:`Table 1 <ddm_api_01_0060__table11812530035>` lists the status codes that may be returned.
.. _ddm_api_01_0060__table11812530035:
.. table:: **Table 1** Normal status codes
=========== ======= ===================================================
Status Code Message Description
=========== ======= ===================================================
200 OK The request has been processed successfully.
202 OK The asynchronous request is submitted successfully.
=========== ======= ===================================================
Abnormal
--------
:ref:`Table 2 <ddm_api_01_0060__table3690182516187>` lists the status codes that may be returned.
.. _ddm_api_01_0060__table3690182516187:
.. table:: **Table 2** Abnormal status codes
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| Status Code | Message | Description |
+=======================+==========================+===============================================================================================================+
| 400 | Bad Request | The server fails to process the request. The possible causes are as follows: |
| | | |
| | | - The request could not be parsed by the server due to incorrect syntax. |
| | | - Request parameters are incorrect. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 401 | Unauthorized | Necessary credentials (for example, username and password) required for user authentication are not provided. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 403 | Forbidden | You are forbidden to access the page requested. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 404 | Not Found | The request failed because the requested resource could not be found on the server. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 405 | Method Not Allowed | You are not allowed to use the method specified in the request. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 409 | Conflict | The request could not be processed due to a conflict with the current resource status. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 413 | Request Entity Too Large | The requested resource exceeds the resource quota. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 415 | Unsupported Media Type | **ContentType** contained in the request header is neither **application** nor **json**. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 500 | Internal Server Error | The request is not completed due to a service error. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 501 | Not Implemented | The request is not completed because the server does not support the requested function. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
| 503 | Service Unavailable | The request could not be processed by the server because the server is being maintained or overloaded. |
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+

66
api-ref/source/appendix/status_description.rst Normal file
View File

@ -0,0 +1,66 @@
:original_name: ddm_api_01_0064.html
.. _ddm_api_01_0064:
Status Description
==================
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. |
+--------------------------+--------------------------------------------------------------------------+
| FREEZING | The DDM instance is being frozen. |
+--------------------------+--------------------------------------------------------------------------+
| FROZEN | The DDM instance is frozen. |
+--------------------------+--------------------------------------------------------------------------+
| UNFREEZING | The DDM instance is being unfrozen. |
+--------------------------+--------------------------------------------------------------------------+
| RESIZING | Class of the DDM instance fail to be changed. |
+--------------------------+--------------------------------------------------------------------------+
| UPGRADE_VERSION_INSTANCE | The version is being upgraded. |
+--------------------------+--------------------------------------------------------------------------+
| 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. |
+--------------------------+--------------------------------------------------------------------------+
| ONDEMAND_TO_PERIOD | The billing mode of the DDM instance is being changed to yearly/monthly. |
+--------------------------+--------------------------------------------------------------------------+
| PERIOD_RESOURCE_SPEC_CHG | The change to the yearly/monthly DDM instance is being verified. |
+--------------------------+--------------------------------------------------------------------------+
DDM Schema Statuses
-------------------
.. table:: **Table 2** DDM schema statuses
================== ====================================
Status Description
================== ====================================
CREATING 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.
Scaling out The schema is being scaled out.
Scaling out failed The schema fails to be scaled out.
Rolling back The schema is being rolled back.
================== ====================================

Some files were not shown because too many files have changed in this diff Show More