Update content
This commit is contained in:
parent
be3990e824
commit
cf83b4e848
BIN
api-ref/source/_static/images/en-us_image_0000001685146158.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001685146158.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001733265073.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001733265073.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001733265081.jpg
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001733265081.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
82
api-ref/source/api_overview.rst
Normal file
82
api-ref/source/api_overview.rst
Normal file
@ -0,0 +1,82 @@
|
||||
: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. |
|
||||
+---------------------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
16
api-ref/source/apis_recommended/ddm_accounts/index.rst
Normal file
16
api-ref/source/apis_recommended/ddm_accounts/index.rst
Normal file
@ -0,0 +1,16 @@
|
||||
:original_name: ddm_api_01_0041.html
|
||||
|
||||
.. _ddm_api_01_0041:
|
||||
|
||||
DDM Accounts
|
||||
============
|
||||
|
||||
- :ref:`Managing the Administrator Password <ddm_api_01_0101>`
|
||||
- :ref:`Validating Password Strength <ddm_api_01_0102>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
managing_the_administrator_password
|
||||
validating_password_strength
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
50
api-ref/source/apis_recommended/ddm_instances/index.rst
Normal file
50
api-ref/source/apis_recommended/ddm_instances/index.rst
Normal 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
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
20
api-ref/source/apis_recommended/index.rst
Normal file
20
api-ref/source/apis_recommended/index.rst
Normal 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
14
api-ref/source/apis_recommended/monitoring/index.rst
Normal 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
|
||||
File diff suppressed because it is too large
Load Diff
234
api-ref/source/apis_recommended/schemas/creating_a_schema.rst
Normal file
234
api-ref/source/apis_recommended/schemas/creating_a_schema.rst
Normal file
File diff suppressed because it is too large
Load Diff
163
api-ref/source/apis_recommended/schemas/deleting_a_schema.rst
Normal file
163
api-ref/source/apis_recommended/schemas/deleting_a_schema.rst
Normal file
File diff suppressed because it is too large
Load Diff
22
api-ref/source/apis_recommended/schemas/index.rst
Normal file
22
api-ref/source/apis_recommended/schemas/index.rst
Normal 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
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
210
api-ref/source/apis_recommended/schemas/querying_schemas.rst
Normal file
210
api-ref/source/apis_recommended/schemas/querying_schemas.rst
Normal file
File diff suppressed because it is too large
Load Diff
29
api-ref/source/appendix/abnormal_request_results.rst
Normal file
29
api-ref/source/appendix/abnormal_request_results.rst
Normal 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
242
api-ref/source/appendix/error_codes.rst
Normal file
File diff suppressed because it is too large
Load Diff
24
api-ref/source/appendix/index.rst
Normal file
24
api-ref/source/appendix/index.rst
Normal 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:`Node Classes <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
|
||||
node_classes
|
||||
obtaining_a_project_id
|
||||
status_description
|
||||
18
api-ref/source/appendix/node_classes.rst
Normal file
18
api-ref/source/appendix/node_classes.rst
Normal 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
|
||||
================== ===== =========== ============
|
||||
66
api-ref/source/appendix/obtaining_a_project_id.rst
Normal file
66
api-ref/source/appendix/obtaining_a_project_id.rst
Normal 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_0000001733265081.jpg
|
||||
:alt: **Figure 1** Viewing project IDs
|
||||
|
||||
**Figure 1** Viewing project IDs
|
||||
60
api-ref/source/appendix/status_codes.rst
Normal file
60
api-ref/source/appendix/status_codes.rst
Normal 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. |
|
||||
+-----------------------+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
61
api-ref/source/appendix/status_description.rst
Normal file
61
api-ref/source/appendix/status_description.rst
Normal file
@ -0,0 +1,61 @@
|
||||
:original_name: ddm_api_01_0064.html
|
||||
|
||||
.. _ddm_api_01_0064:
|
||||
|
||||
Status Description
|
||||
==================
|
||||
|
||||
DDM Instance Statuses
|
||||
---------------------
|
||||
|
||||
.. table:: **Table 1** DDM instance statuses
|
||||
|
||||
================= =============================================
|
||||
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
|
||||
-------------------
|
||||
|
||||
.. table:: **Table 2** DDM schema statuses
|
||||
|
||||
================== ====================================
|
||||
Status Description
|
||||
================== ====================================
|
||||
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.
|
||||
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.
|
||||
================== ====================================
|
||||
|
||||
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.
|
||||
=========== ========================================
|
||||
8
api-ref/source/before_you_start/api_calling.rst
Normal file
8
api-ref/source/before_you_start/api_calling.rst
Normal file
@ -0,0 +1,8 @@
|
||||
:original_name: ddm_api_01_0003.html
|
||||
|
||||
.. _ddm_api_01_0003:
|
||||
|
||||
API Calling
|
||||
===========
|
||||
|
||||
DDM supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS.
|
||||
36
api-ref/source/before_you_start/concepts.rst
Normal file
36
api-ref/source/before_you_start/concepts.rst
Normal file
@ -0,0 +1,36 @@
|
||||
:original_name: ddm_api_01_0006.html
|
||||
|
||||
.. _ddm_api_01_0006:
|
||||
|
||||
Concepts
|
||||
========
|
||||
|
||||
- Account
|
||||
|
||||
An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.
|
||||
|
||||
- IAM user
|
||||
|
||||
An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).
|
||||
|
||||
- Region
|
||||
|
||||
A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
|
||||
|
||||
- AZ
|
||||
|
||||
An AZ comprises one or more physical data centers equipped with independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow users to build cross-AZ high-availability systems.
|
||||
|
||||
- Project
|
||||
|
||||
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_0000001733265073.png
|
||||
:alt: **Figure 1** Project isolating model
|
||||
|
||||
**Figure 1** Project isolating model
|
||||
|
||||
- Enterprise project
|
||||
|
||||
Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated from each other. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from the enterprise project.
|
||||
9
api-ref/source/before_you_start/constraints.rst
Normal file
9
api-ref/source/before_you_start/constraints.rst
Normal file
@ -0,0 +1,9 @@
|
||||
:original_name: ddm_api_01_0005.html
|
||||
|
||||
.. _ddm_api_01_0005:
|
||||
|
||||
Constraints
|
||||
===========
|
||||
|
||||
- The number of DDM instances that you can create is determined by your quota.
|
||||
- For more constraints, see API description.
|
||||
8
api-ref/source/before_you_start/endpoints.rst
Normal file
8
api-ref/source/before_you_start/endpoints.rst
Normal file
@ -0,0 +1,8 @@
|
||||
:original_name: ddm_api_01_0004.html
|
||||
|
||||
.. _ddm_api_01_0004:
|
||||
|
||||
Endpoints
|
||||
=========
|
||||
|
||||
An endpoint is the **request address** for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see `Regions and Endpoints <https://docs.otc.t-systems.com/endpoint/index.html>`__.
|
||||
22
api-ref/source/before_you_start/index.rst
Normal file
22
api-ref/source/before_you_start/index.rst
Normal file
@ -0,0 +1,22 @@
|
||||
:original_name: ddm_api_01_0001.html
|
||||
|
||||
.. _ddm_api_01_0001:
|
||||
|
||||
Before You Start
|
||||
================
|
||||
|
||||
- :ref:`Overview <ddm_api_01_0002>`
|
||||
- :ref:`API Calling <ddm_api_01_0003>`
|
||||
- :ref:`Endpoints <ddm_api_01_0004>`
|
||||
- :ref:`Constraints <ddm_api_01_0005>`
|
||||
- :ref:`Concepts <ddm_api_01_0006>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
overview
|
||||
api_calling
|
||||
endpoints
|
||||
constraints
|
||||
concepts
|
||||
17
api-ref/source/before_you_start/overview.rst
Normal file
17
api-ref/source/before_you_start/overview.rst
Normal file
@ -0,0 +1,17 @@
|
||||
:original_name: ddm_api_01_0002.html
|
||||
|
||||
.. _ddm_api_01_0002:
|
||||
|
||||
Overview
|
||||
========
|
||||
|
||||
Welcome to Distributed Database Middleware (DDM). This document describes functions, syntax, parameters, and examples of DDM.
|
||||
|
||||
If you plan to access DDM through an API, ensure that you are familiar with DDM concepts.
|
||||
|
||||
This document describes how to use application programming interfaces (APIs) to perform creating, querying, deleting, and updating operations.
|
||||
|
||||
.. note::
|
||||
|
||||
- This document will be updated when APIs of new functions are added, for example, adding response parameters.
|
||||
- To reduce impacts caused by API changes, DDM is backward compatible with existing APIs. When using DDM, you should accept and ignore unused parameters and parameter values in JSON responses.
|
||||
55
api-ref/source/calling_apis/authentication.rst
Normal file
55
api-ref/source/calling_apis/authentication.rst
Normal file
@ -0,0 +1,55 @@
|
||||
:original_name: ddm_api_01_0011.html
|
||||
|
||||
.. _ddm_api_01_0011:
|
||||
|
||||
Authentication
|
||||
==============
|
||||
|
||||
Token authentication is required to call APIs.
|
||||
|
||||
Authentication using tokens: General requests are authenticated using tokens.
|
||||
|
||||
Token-based Authentication
|
||||
--------------------------
|
||||
|
||||
.. note::
|
||||
|
||||
The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.
|
||||
|
||||
A token specifies temporary permissions in a computer system. Token-based authentication adds a token in a request as its header during API calling to obtain the permissions for operating APIs on IAM.
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"auth": {
|
||||
"identity": {
|
||||
"methods": [
|
||||
"password"
|
||||
],
|
||||
"password": {
|
||||
"user": {
|
||||
"name": "username",
|
||||
"password": "********",
|
||||
"domain": {
|
||||
"name": "domainname"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scope": {
|
||||
"project": {
|
||||
"name": "xxxxxxxx"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
In :ref:`Making an API Request <ddm_03_0002>`, the process of calling the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__ is described.
|
||||
|
||||
After obtaining the token, add the **X-Auth-Token** header in a request to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{{Endpoint}}/v3/auth/projects
|
||||
Content-Type: application/json
|
||||
X-Auth-Token: ABCDEFJ....
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user