ahmet.yildirim/distributed-cache-service
1
0
Fork 0
forked from docs/distributed-cache-service
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-01-12 02:25:11 +00:00
parent 3bfe43b812
commit 700199e2af
7 changed files with 159 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/backup_and_restoration_apis/deleting_backup_files.rst
View File

@ -38,6 +38,8 @@ None
**Example request** **Example request**
Request URL:
.. code-block:: text .. code-block:: text
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id} DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}

4
api-ref/source/backup_and_restoration_apis/restoring_a_dcs_instance.rst
View File

@ -52,10 +52,14 @@ Request
**Example request** **Example request**
Request URL:
.. code-block:: text .. code-block:: text
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores
Example:
.. code-block:: .. code-block::
{ {

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

@ -10,10 +10,17 @@ Change History
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | What's New | | Released On | What's New |
+===================================+====================================================================================================================================================================================================================================================================================================================================+ +===================================+====================================================================================================================================================================================================================================================================================================================================+
| 2022-12-13 | Modified the following content: |
| | |
| | - In section :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`, added the **include_failure** parameter and deleted the **isExactMatchName** parameter. |
| | - In section :ref:`Querying DCS Instance Status <dcs-api-0312016>`, added parameters such as **redis**, and changed the **includeFailure** parameter to **include_failure**. |
| | - Updated the example request format in section :ref:`Deleting Backup Files <dcs-api-0312024>`. |
| | - In section :ref:`Querying AZ Information <dcs-api-0312039>`, changed the **regionID** parameter to **region_id**. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-10-12 | Modified the following content: | | 2022-10-12 | Modified the following content: |
| | | | | |
| | - Changed the type of the **private_ips** parameter to **Array of strings** in :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. | | | - Changed the type of the **private_ips** parameter to **Array of strings** in :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. |
| | - Deleted the **includeFailure** parameter from :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`. | | | - In section :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`, deleted the **includeFailure** parameter. |
| | - Modified the description of the **maxmemory-policy** parameter in :ref:`Parameter Management APIs <dcs-api-0312013>`. | | | - Modified the description of the **maxmemory-policy** parameter in :ref:`Parameter Management APIs <dcs-api-0312013>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-08-04 | Modified the following content: | | 2022-08-04 | Modified the following content: |
@ -50,11 +57,11 @@ Change History
| | | | | |
| | - Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs. | | | - Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs. |
| | - Added description about creating DCS Redis 4.0 and 5.0 instances in section :ref:`Creating a DCS Instance <dcs-api-0312004>`. | | | - Added description about creating DCS Redis 4.0 and 5.0 instances in section :ref:`Creating a DCS Instance <dcs-api-0312004>`. |
| | - Optimized :ref:`Error Codes <dcs-api-0312044>`. | | | - Optimized section "Error Code." |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-06-16 | Modified the following content: | | 2020-06-16 | Modified the following content: |
| | | | | |
| | Added error codes such as 111400102 in section :ref:`Error Codes <dcs-api-0312044>`. | | | Added error codes such as 111400102 in the **Error Codes** section. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-03-25 | Modified the following content: | | 2020-03-25 | Modified the following content: |
| | | | | |

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

@ -94,9 +94,6 @@ html_title = "Distributed Cache Service - API Reference"
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# Do not include sources into the rendered results
html_copy_source = False
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
latex_documents = [ latex_documents = [
('index', ('index',

145
api-ref/source/instance_management_apis/querying_dcs_instance_status.rst
View File

File diff suppressed because it is too large Load Diff

36
api-ref/source/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst
View File

@ -13,7 +13,7 @@ This API is used to query DCS instances of a tenant, and allows you to specify q
URI URI
--- ---
GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value} GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&include_failure={include_failure}&ip={ip}&tags={key}={value}
:ref:`Table 1 <dcs-api-0312006__table1971216413394>` describes the parameters. :ref:`Table 1 <dcs-api-0312006__table1971216413394>` describes the parameters.
@ -21,15 +21,15 @@ GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status=
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description | | Parameter | Type | Mandatory | Description |
+==================+==================+=================+======================================================================================================================+ +=================+==================+=================+=======================================================================================================================+
| project_id | String | Yes | Project ID. | | project_id | String | Yes | Project ID. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| start | Integer | No | Start number for querying DCS instances. It cannot be lower than 1. | | start | Integer | No | Start number for querying DCS instances. It cannot be lower than 1. |
| | | | | | | | | |
| | | | By default, the start number is 1. | | | | | By default, the start number is 1. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| limit | Integer | No | Number of DCS instances displayed on each page. | | limit | Integer | No | Number of DCS instances displayed on each page. |
| | | | | | | | | |
| | | | Minimum value: **1** | | | | | Minimum value: **1** |
@ -37,34 +37,32 @@ GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status=
| | | | Maximum value: **2000** | | | | | Maximum value: **2000** |
| | | | | | | | | |
| | | | If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page. | | | | | If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| name | String | No | DCS instance name. | | name | String | No | DCS instance name. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| id | String | No | Instance ID. | | id | String | No | Instance ID. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| status | String | No | DCS instance status. For details about status, see :ref:`DCS Instance Statuses <dcs-api-0312047>`. | | status | String | No | DCS instance status. For details about status, see :ref:`DCS Instance Statuses <dcs-api-0312047>`. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| ip | String | No | IP address for connecting to the DCS instance | | ip | String | No | IP address for connecting to the DCS instance |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| isExactMatchName | String | No | An indicator of whether to perform an exact or fuzzy match based on instance name. | | include_failure | String | No | An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. |
| | | | | | | | | |
| | | | Options: | | | | | Options: |
| | | | | | | | | |
| | | | - **true**: exact match | | | | | - **true**: The number of DCS instances that failed to be created will be returned to the API caller. |
| | | | - **false**: fuzzy match | | | | | - **false** or others: The number of DCS instances that failed to be created will not be returned to the API caller. |
| | | | | +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
| | | | Default value: **false**. |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
| tags | Array of Objects | No | Query based on the instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. | | tags | Array of Objects | No | Query based on the instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. |
| | | | | | | | | |
| | | | To query instances with multiple tag keys and values, separate key-value pairs with commas (,). | | | | | To query instances with multiple tag keys and values, separate key-value pairs with commas (,). |
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
**Example** **Example**
.. code-block:: text .. code-block:: text
GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&isExactMatchName=false GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&include_failure=true
Request Request
------- -------
@ -95,7 +93,7 @@ Response
instance_num Integer Number of DCS instances. instance_num Integer Number of DCS instances.
============ ======= ============================== ============ ======= ==============================
.. table:: **Table 3** Parameter description of the instance array .. table:: **Table 3** instances parameters
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |

2
api-ref/source/other_apis/querying_az_information.rst
View File

@ -40,7 +40,7 @@ Response
+-----------------+--------+---------------------------------------------------------------------------------------+ +-----------------+--------+---------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=================+========+=======================================================================================+ +=================+========+=======================================================================================+
| regionId | String | Region ID. | | region_id | String | Region ID. |
+-----------------+--------+---------------------------------------------------------------------------------------+ +-----------------+--------+---------------------------------------------------------------------------------------+
| available_zones | Array | Array of AZs. For details, see :ref:`Table 2 <dcs-api-0312039__table20901104905614>`. | | available_zones | Array | Array of AZs. For details, see :ref:`Table 2 <dcs-api-0312039__table20901104905614>`. |
+-----------------+--------+---------------------------------------------------------------------------------------+ +-----------------+--------+---------------------------------------------------------------------------------------+