Compare commits
5 Commits
main
...
propose-dc
| Author | SHA1 | Date | |
|---|---|---|---|
| 1e260e9164 | |||
| af3766e24f | |||
| f235b93832 | |||
| 00efc02c41 | |||
| cad3516da2 |
BIN
api-ref/source/_static/images/en-us_image_0000001287593560.jpg
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001287593560.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
12
api-ref/source/api_usage_guidelines.rst
Normal file
12
api-ref/source/api_usage_guidelines.rst
Normal file
@ -0,0 +1,12 @@
|
||||
:original_name: dcs-api-0417001.html
|
||||
|
||||
.. _dcs-api-0417001:
|
||||
|
||||
API Usage Guidelines
|
||||
====================
|
||||
|
||||
Distributed Cache Service (DCS) APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: **https://Endpoint/**\ **uri**. In the URL, **uri** indicates the resource path, that is, the API access path.
|
||||
|
||||
DCS APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by **Application/json**.
|
||||
|
||||
For details on how to use APIs, see `API Usage Guidelines <https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API%20Documents>`__.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,87 @@
|
||||
:original_name: dcs-api-0312024.html
|
||||
|
||||
.. _dcs-api-0312024:
|
||||
|
||||
Deleting Backup Files
|
||||
=====================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete the files backed up by a DCS instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
|
||||
|
||||
:ref:`Table 1 <dcs-api-0312024__table4154121820350>` describes the parameters.
|
||||
|
||||
.. _dcs-api-0312024__table4154121820350:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ====== ========= =======================
|
||||
Parameter Type Mandatory Description
|
||||
=========== ====== ========= =======================
|
||||
project_id String Yes Project ID
|
||||
instance_id String Yes DCS instance ID
|
||||
backup_id String Yes ID of the backup record
|
||||
=========== ====== ========= =======================
|
||||
|
||||
Example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{dcs_endpoint}/v1.0/885cacf2d49d4bb6931ae668e9c07553/instances/e016385d-b9fa-4bf0-9f38-9379f4a5293f/backups/75509c85-50a6-4525-ad56-a1bb62e84570
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
|
||||
**Example request**
|
||||
|
||||
None.
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
**Response parameters**
|
||||
|
||||
:ref:`Table 2 <dcs-api-0312024__table5929344419>` describes the response parameters.
|
||||
|
||||
.. _dcs-api-0312024__table5929344419:
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
========= ====== ==================================
|
||||
Parameter Type Description
|
||||
========= ====== ==================================
|
||||
message String Result of deleting the backup file
|
||||
========= ====== ==================================
|
||||
|
||||
**Example response**
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"message": ""
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
:ref:`Table 3 <dcs-api-0312024__table8301101911215>` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 <dcs-api-0312043__table5210141351517>`.
|
||||
|
||||
.. _dcs-api-0312024__table8301101911215:
|
||||
|
||||
.. table:: **Table 3** Status code
|
||||
|
||||
=========== =================================
|
||||
Status Code Description
|
||||
=========== =================================
|
||||
200 Backup file deleted successfully.
|
||||
=========== =================================
|
||||
@ -0,0 +1,34 @@
|
||||
:original_name: dcs-api-0312013.html
|
||||
|
||||
.. _dcs-api-0312013:
|
||||
|
||||
APIs Used for Maintaining DCS Instances
|
||||
=======================================
|
||||
|
||||
- :ref:`Querying Statistics of All Running Instances <dcs-api-0312014>`
|
||||
- :ref:`Querying DCS Instance Configuration Parameters <dcs-api-0312015>`
|
||||
- :ref:`Querying DCS Instance Status <dcs-api-0312016>`
|
||||
- :ref:`Modifying DCS Instance Configuration Parameters <dcs-api-0312017>`
|
||||
- :ref:`Restarting DCS Instances <dcs-api-0312018>`
|
||||
- :ref:`Changing the Password of a DCS Instance <dcs-api-0312019>`
|
||||
- :ref:`Backing Up a DCS Instance <dcs-api-0312020>`
|
||||
- :ref:`Restoring a DCS Instance <dcs-api-0312021>`
|
||||
- :ref:`Querying DCS Instance Backup Records <dcs-api-0312022>`
|
||||
- :ref:`Querying DCS Instance Restoration Records <dcs-api-0312023>`
|
||||
- :ref:`Deleting Backup Files <dcs-api-0312024>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_statistics_of_all_running_instances
|
||||
querying_dcs_instance_configuration_parameters
|
||||
querying_dcs_instance_status
|
||||
modifying_dcs_instance_configuration_parameters
|
||||
restarting_dcs_instances
|
||||
changing_the_password_of_a_dcs_instance
|
||||
backing_up_a_dcs_instance
|
||||
restoring_a_dcs_instance
|
||||
querying_dcs_instance_backup_records
|
||||
querying_dcs_instance_restoration_records
|
||||
deleting_backup_files
|
||||
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
@ -0,0 +1,98 @@
|
||||
:original_name: dcs-api-0312016.html
|
||||
|
||||
.. _dcs-api-0312016:
|
||||
|
||||
Querying DCS Instance Status
|
||||
============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to query the number of instances in different states.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}
|
||||
|
||||
:ref:`Table 1 <dcs-api-0312016__table1624017336377>` describes the parameters.
|
||||
|
||||
.. _dcs-api-0312016__table1624017336377:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+=================+=================+=================+============================================================================================================================+
|
||||
| project_id | String | Yes | Project ID. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| includeFailure | String | No | An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options: |
|
||||
| | | | |
|
||||
| | | | - **true**: The number of DCS instances that failed to be created will be returned to the API caller. |
|
||||
| | | | - **false** or others: The number of DCS instances that failed to be created will not be returned to the API caller. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?includeFailure=true
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
**Response parameters**
|
||||
|
||||
:ref:`Table 2 <dcs-api-0312016__table595111370375>` describes the response parameters.
|
||||
|
||||
.. _dcs-api-0312016__table595111370375:
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
================== ======= =============================================
|
||||
Parameter Type Description
|
||||
================== ======= =============================================
|
||||
creating_count Integer Number of instances that are being created.
|
||||
deleting_count Integer Number of instances that are being deleted.
|
||||
running_count Integer Number of running instances.
|
||||
error_count Integer Number of abnormal instances.
|
||||
restarting_count Integer Number of instances that are being restarted.
|
||||
createfailed_count Integer Number of instances that fail to be created.
|
||||
extending_count Integer Number of instances that are being scaled up.
|
||||
================== ======= =============================================
|
||||
|
||||
**Example response**
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"extending_count": 0,
|
||||
"creating_count": 0,
|
||||
"deleting_count": 0,
|
||||
"running_count": 16,
|
||||
"error_count": 0,
|
||||
"restarting_count": 0,
|
||||
"createfailed_count": 44
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
:ref:`Table 3 <dcs-api-0312016__table36591653133>` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 <dcs-api-0312043__table5210141351517>`.
|
||||
|
||||
.. _dcs-api-0312016__table36591653133:
|
||||
|
||||
.. table:: **Table 3** Status code
|
||||
|
||||
+-------------+-------------------------------------------------------------------------+
|
||||
| Status Code | Description |
|
||||
+=============+=========================================================================+
|
||||
| 200 | Quantities of DCS instances in different statuses queried successfully. |
|
||||
+-------------+-------------------------------------------------------------------------+
|
||||
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
@ -0,0 +1,70 @@
|
||||
:original_name: dcs-api-0312008.html
|
||||
|
||||
.. _dcs-api-0312008:
|
||||
|
||||
Deleting a Single DCS Instance
|
||||
==============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a specified DCS instance to free up all resources occupied by the DCS instance.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v1.0/{project_id}/instances/{instance_id}
|
||||
|
||||
:ref:`Table 1 <dcs-api-0312008__table4154121820350>` describes the parameter.
|
||||
|
||||
.. _dcs-api-0312008__table4154121820350:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ====== ========= ===============
|
||||
Parameter Type Mandatory Description
|
||||
=========== ====== ========= ===============
|
||||
project_id String Yes Project ID
|
||||
instance_id String Yes DCS instance ID
|
||||
=========== ====== ========= ===============
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
|
||||
**Example request**
|
||||
|
||||
Request URL:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
**Response parameters**
|
||||
|
||||
None.
|
||||
|
||||
**Example response**
|
||||
|
||||
None.
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
:ref:`Table 2 <dcs-api-0312008__table8301101911215>` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 <dcs-api-0312043__table5210141351517>`.
|
||||
|
||||
.. _dcs-api-0312008__table8301101911215:
|
||||
|
||||
.. table:: **Table 2** Status code
|
||||
|
||||
=========== ===================================
|
||||
Status Code Description
|
||||
=========== ===================================
|
||||
204 DCS instances deleted successfully.
|
||||
=========== ===================================
|
||||
@ -0,0 +1,26 @@
|
||||
:original_name: dcs-api-0312003.html
|
||||
|
||||
.. _dcs-api-0312003:
|
||||
|
||||
APIs Used for Managing DCS Instances
|
||||
====================================
|
||||
|
||||
- :ref:`Creating a DCS Instance <dcs-api-0312004>`
|
||||
- :ref:`Querying a DCS Instance <dcs-api-0312005>`
|
||||
- :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`
|
||||
- :ref:`Modifying Information About a DCS Instance <dcs-api-0312007>`
|
||||
- :ref:`Deleting a Single DCS Instance <dcs-api-0312008>`
|
||||
- :ref:`Batch Deleting DCS Instances <dcs-api-0312009>`
|
||||
- :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_dcs_instance
|
||||
querying_a_dcs_instance
|
||||
querying_all_dcs_instances_of_a_tenant
|
||||
modifying_information_about_a_dcs_instance
|
||||
deleting_a_single_dcs_instance
|
||||
batch_deleting_dcs_instances
|
||||
scaling_up_a_dcs_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
@ -0,0 +1,84 @@
|
||||
:original_name: dcs-api-0312010.html
|
||||
|
||||
.. _dcs-api-0312010:
|
||||
|
||||
Scaling Up a DCS Instance
|
||||
=========================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to scale up a DCS Redis instance in the **Running** state.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
POST /v1.0/{project_id}/instances/{instance_id}/extend
|
||||
|
||||
:ref:`Table 1 <dcs-api-0312010__table4154121820350>` describes the parameters.
|
||||
|
||||
.. _dcs-api-0312010__table4154121820350:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ====== ========= ============
|
||||
Parameter Type Mandatory Description
|
||||
=========== ====== ========= ============
|
||||
project_id String Yes Project ID.
|
||||
instance_id String Yes Instance ID.
|
||||
=========== ====== ========= ============
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
:ref:`Table 2 <dcs-api-0312010__table166993107405>` describes the request parameters.
|
||||
|
||||
.. _dcs-api-0312010__table166993107405:
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+--------------+---------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+==============+=========+===========+===================================================================================================================================================================================+
|
||||
| new_capacity | Integer | Yes | New specification (memory space) of the DCS instance. The new specification to which the DCS instance will be scaled up must be greater than the current specification. Unit: GB. |
|
||||
+--------------+---------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/extend
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"new_capacity": 4
|
||||
}
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
**Response parameters**
|
||||
|
||||
None.
|
||||
|
||||
**Example response**
|
||||
|
||||
None.
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
:ref:`Table 3 <dcs-api-0312010__table8301101911215>` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 <dcs-api-0312043__table5210141351517>`.
|
||||
|
||||
.. _dcs-api-0312010__table8301101911215:
|
||||
|
||||
.. table:: **Table 3** Status code
|
||||
|
||||
=========== ====================================
|
||||
Status Code Description
|
||||
=========== ====================================
|
||||
204 DCS instance scaled up successfully.
|
||||
=========== ====================================
|
||||
14
api-ref/source/apis_used_for_tenant_management/index.rst
Normal file
14
api-ref/source/apis_used_for_tenant_management/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
:original_name: dcs-api-0312035.html
|
||||
|
||||
.. _dcs-api-0312035:
|
||||
|
||||
APIs Used for Tenant Management
|
||||
===============================
|
||||
|
||||
- :ref:`Querying the Quota of a Tenant <dcs-api-0312036>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_the_quota_of_a_tenant
|
||||
File diff suppressed because it is too large
Load Diff
28
api-ref/source/appendix/dcs_instance_statuses.rst
Normal file
28
api-ref/source/appendix/dcs_instance_statuses.rst
Normal file
@ -0,0 +1,28 @@
|
||||
:original_name: dcs-api-0312047.html
|
||||
|
||||
.. _dcs-api-0312047:
|
||||
|
||||
DCS Instance Statuses
|
||||
=====================
|
||||
|
||||
.. table:: **Table 1** DCS instance statuses
|
||||
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| State | Description |
|
||||
+===================================+==========================================================================+
|
||||
| CREATING | Creating is the status before the Running state. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| CREATEFAILED | The DCS instance failed to be created. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| RUNNING | The instance is running properly. |
|
||||
| | |
|
||||
| | Only instances in the Running state can provide in-memory cache service. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| ERROR | The instance is not running properly. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| RESTARTING | The instance is being restarted. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| EXTENDING | The instance is being scaled up. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
| RESTORING | The instance data is being restored. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
332
api-ref/source/appendix/error_codes.rst
Normal file
332
api-ref/source/appendix/error_codes.rst
Normal file
File diff suppressed because it is too large
Load Diff
20
api-ref/source/appendix/index.rst
Normal file
20
api-ref/source/appendix/index.rst
Normal file
@ -0,0 +1,20 @@
|
||||
:original_name: dcs-api-0312042.html
|
||||
|
||||
.. _dcs-api-0312042:
|
||||
|
||||
Appendix
|
||||
========
|
||||
|
||||
- :ref:`Status Codes <dcs-api-0312043>`
|
||||
- :ref:`Error Codes <dcs-api-0312044>`
|
||||
- :ref:`Obtaining a Project ID <dcs-api-0312045>`
|
||||
- :ref:`DCS Instance Statuses <dcs-api-0312047>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
status_codes
|
||||
error_codes
|
||||
obtaining_a_project_id
|
||||
dcs_instance_statuses
|
||||
25
api-ref/source/appendix/obtaining_a_project_id.rst
Normal file
25
api-ref/source/appendix/obtaining_a_project_id.rst
Normal file
@ -0,0 +1,25 @@
|
||||
:original_name: dcs-api-0312045.html
|
||||
|
||||
.. _dcs-api-0312045:
|
||||
|
||||
Obtaining a Project ID
|
||||
======================
|
||||
|
||||
Obtaining a Project ID on the Console
|
||||
-------------------------------------
|
||||
|
||||
A project ID is required for some URLs when an API is called. You can obtain a project ID on the console.
|
||||
|
||||
The following procedure describes how to obtain a project ID:
|
||||
|
||||
#. Sign up and log in to the management console.
|
||||
|
||||
#. Click the username and choose **My Credential** from the drop-down list.
|
||||
|
||||
On the **My Credential** page, view project IDs in the project list.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001287593560.jpg
|
||||
:alt: **Figure 1** Viewing project IDs
|
||||
|
||||
**Figure 1** Viewing project IDs
|
||||
120
api-ref/source/appendix/status_codes.rst
Normal file
120
api-ref/source/appendix/status_codes.rst
Normal file
File diff suppressed because it is too large
Load Diff
65
api-ref/source/change_history.rst
Normal file
65
api-ref/source/change_history.rst
Normal file
@ -0,0 +1,65 @@
|
||||
:original_name: dcs-api-0312049.html
|
||||
|
||||
.. _dcs-api-0312049:
|
||||
|
||||
Change History
|
||||
==============
|
||||
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Released On | What's New |
|
||||
+===================================+====================================================================================================================================================================================================================================================================================================================================+
|
||||
| 2020-06-16 | Modified the following content: |
|
||||
| | |
|
||||
| | Added error codes such as 111400102 in section :ref:`Error Codes <dcs-api-0312044>`. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2020-03-25 | Modified the following content: |
|
||||
| | |
|
||||
| | - Added an example request URL for each API. |
|
||||
| | - Optimized description about the parameters of each API. |
|
||||
| | - Optimized description in section :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`. |
|
||||
| | - Optimized description in sections :ref:`Backing Up a DCS Instance <dcs-api-0312020>`, :ref:`Restoring a DCS Instance <dcs-api-0312021>`, :ref:`Querying DCS Instance Backup Records <dcs-api-0312022>`, :ref:`Querying DCS Instance Restoration Records <dcs-api-0312023>`, and :ref:`Deleting Backup Files <dcs-api-0312024>`. |
|
||||
| | - Added support for scaling up cluster instances in section :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. |
|
||||
| | - Added section :ref:`Status Codes <dcs-api-0312043>`. |
|
||||
| | - Added section :ref:`Obtaining a Project ID <dcs-api-0312045>`. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2019-04-17 | Accepted in OTC-4.0/Agile. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2019-03-30 | Modified the following content: |
|
||||
| | |
|
||||
| | - Removed support for creating DCS instances with the specification of 1 GB in sections :ref:`Creating a DCS Instance <dcs-api-0312004>` and :ref:`Querying Service Specifications <dcs-api-0312040>`. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2018-04-17 | Modified the following content: |
|
||||
| | |
|
||||
| | - Optimized examples in sections :ref:`Creating a DCS Instance <dcs-api-0312004>` and :ref:`Querying AZ Information <dcs-api-0312039>`. |
|
||||
| | - Optimized parameter description in section :ref:`Batch Deleting DCS Instances <dcs-api-0312009>`. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2018-03-16 | Modified the following content: |
|
||||
| | |
|
||||
| | - Added description about the Redis-specific parameter **notify-keyspace-events**, and deleted description about the Redis-specific parameter **maxclients**. For details, see :ref:`Querying DCS Instance Configuration Parameters <dcs-api-0312015>`. |
|
||||
| | - Changed instance password complexity rules. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2017-11-08 | Modified the following content: |
|
||||
| | |
|
||||
| | - Provided support for DCS instances in the cluster mode. |
|
||||
| | - Changed instance password complexity rules. |
|
||||
| | |
|
||||
| | Added the following content: |
|
||||
| | |
|
||||
| | - Added sections :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. |
|
||||
| | - Added sections :ref:`Backing Up a DCS Instance <dcs-api-0312020>` to :ref:`Deleting Backup Files <dcs-api-0312024>`. |
|
||||
| | - Added the **Time Window** parameter. |
|
||||
| | - Added two Redis parameters **maxclients** and **reserved-memory** in section :ref:`Querying DCS Instance Configuration Parameters <dcs-api-0312015>`. |
|
||||
| | - Added some error codes and their description in chapter :ref:`Error Codes <dcs-api-0312044>`. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2017-05-30 | Modified the following content: |
|
||||
| | |
|
||||
| | - Optimized instance query. |
|
||||
| | - Provided a list of DCS error codes. |
|
||||
| | |
|
||||
| | Added the following content: |
|
||||
| | |
|
||||
| | - Batch deletion of DCS instances |
|
||||
| | - Redis-specific parameter **latency-monitor-threshold** |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2017-04-05 | This issue is the first official release. |
|
||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -26,6 +26,9 @@ otcdocs_auto_version = False
|
||||
|
||||
project = 'Distributed Cache Service'
|
||||
otcdocs_repo_name = 'docs/distributed-cache-service'
|
||||
# Those variables are required for edit/bug links
|
||||
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
|
||||
otcdocs_git_type = 'gitea'
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
@ -35,6 +38,9 @@ sys.path.insert(0, os.path.abspath('../'))
|
||||
sys.path.insert(0, os.path.abspath('./'))
|
||||
|
||||
# -- General configuration ----------------------------------------------------
|
||||
# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not
|
||||
# what it is expected
|
||||
smartquotes = False
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
@ -69,11 +75,12 @@ show_authors = False
|
||||
html_theme = 'otcdocs'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
html_theme_options = {
|
||||
'disable_search': True,
|
||||
'site_name': 'Internal Documentation Portal'
|
||||
"disable_search": True,
|
||||
"site_name": "Internal Documentation Portal",
|
||||
"logo_url": "https://docs-int.otc-service.com",
|
||||
}
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
@ -89,8 +96,8 @@ html_static_path = ['_static']
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
('index',
|
||||
('index',
|
||||
'dcs-api-ref.tex',
|
||||
u'Distributed Cache Service - API Reference',
|
||||
u'OpenTelekomCloud', 'manual'),
|
||||
]
|
||||
]
|
||||
|
||||
@ -2,3 +2,13 @@
|
||||
Distributed Cache Service - API Reference
|
||||
=========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api_usage_guidelines
|
||||
apis_used_for_managing_dcs_instances/index
|
||||
apis_used_for_maintaining_dcs_instances/index
|
||||
apis_used_for_tenant_management/index
|
||||
other_apis/index
|
||||
appendix/index
|
||||
change_history
|
||||
|
||||
18
api-ref/source/other_apis/index.rst
Normal file
18
api-ref/source/other_apis/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
:original_name: dcs-api-0312038.html
|
||||
|
||||
.. _dcs-api-0312038:
|
||||
|
||||
Other APIs
|
||||
==========
|
||||
|
||||
- :ref:`Querying AZ Information <dcs-api-0312039>`
|
||||
- :ref:`Querying Service Specifications <dcs-api-0312040>`
|
||||
- :ref:`Querying Maintenance Time Window <dcs-api-0312041>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_az_information
|
||||
querying_service_specifications
|
||||
querying_maintenance_time_window
|
||||
113
api-ref/source/other_apis/querying_az_information.rst
Normal file
113
api-ref/source/other_apis/querying_az_information.rst
Normal file
File diff suppressed because it is too large
Load Diff
118
api-ref/source/other_apis/querying_maintenance_time_window.rst
Normal file
118
api-ref/source/other_apis/querying_maintenance_time_window.rst
Normal file
File diff suppressed because it is too large
Load Diff
212
api-ref/source/other_apis/querying_service_specifications.rst
Normal file
212
api-ref/source/other_apis/querying_service_specifications.rst
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user