Compare commits
10 Commits
propose-dc
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| d0a20ad66d | |||
| e50e044f87 | |||
| 0c129c6fd6 | |||
|
3bfe43b812 | ||
|
|
4bf79b0c29 | ||
|
|
6cb8d28391 | ||
|
|
d5a1e18a55 | ||
| 9d00de4510 | |||
| bfd0af1912 | |||
| 3a9c34d473 |
BIN
api-ref/source/_static/images/en-us_image_0216824199.jpg
Normal file
BIN
api-ref/source/_static/images/en-us_image_0216824199.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>`__.
|
||||
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. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------+
|
||||
512
api-ref/source/appendix/error_codes.rst
Normal file
512
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_0216824199.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
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,83 @@
|
||||
: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
|
||||
=========== ====== ========= =======================
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
|
||||
|
||||
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.
|
||||
=========== =================================
|
||||
22
api-ref/source/backup_and_restoration_apis/index.rst
Normal file
22
api-ref/source/backup_and_restoration_apis/index.rst
Normal file
@ -0,0 +1,22 @@
|
||||
:original_name: dcs-api-0514005.html
|
||||
|
||||
.. _dcs-api-0514005:
|
||||
|
||||
Backup and Restoration APIs
|
||||
===========================
|
||||
|
||||
- :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:
|
||||
|
||||
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
109
api-ref/source/change_history.rst
Normal file
109
api-ref/source/change_history.rst
Normal file
File diff suppressed because it is too large
Load Diff
@ -94,6 +94,9 @@ html_title = "Distributed Cache Service - API Reference"
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Do not include sources into the rendered results
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
('index',
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
14
api-ref/source/data_migration_apis/index.rst
Normal file
14
api-ref/source/data_migration_apis/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
:original_name: dcs-api-0514003.html
|
||||
|
||||
.. _dcs-api-0514003:
|
||||
|
||||
Data Migration APIs
|
||||
===================
|
||||
|
||||
- :ref:`Creating a Data Migration Task <dcs-api-0514004>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_data_migration_task
|
||||
@ -2,3 +2,16 @@
|
||||
Distributed Cache Service - API Reference
|
||||
=========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api_usage_guidelines
|
||||
lifecycle_management_apis/index
|
||||
instance_management_apis/index
|
||||
parameter_management_apis/index
|
||||
data_migration_apis/index
|
||||
backup_and_restoration_apis/index
|
||||
network_security/index
|
||||
other_apis/index
|
||||
appendix/index
|
||||
change_history
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
20
api-ref/source/instance_management_apis/index.rst
Normal file
20
api-ref/source/instance_management_apis/index.rst
Normal file
@ -0,0 +1,20 @@
|
||||
:original_name: dcs-api-0312035.html
|
||||
|
||||
.. _dcs-api-0312035:
|
||||
|
||||
Instance Management APIs
|
||||
========================
|
||||
|
||||
- :ref:`Restarting DCS Instances or Clearing DCS Instance Data <dcs-api-0312018>`
|
||||
- :ref:`Querying Statistics of All Running Instances <dcs-api-0312014>`
|
||||
- :ref:`Querying DCS Instance Status <dcs-api-0312016>`
|
||||
- :ref:`Changing the Password of a DCS Instance <dcs-api-0312019>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
restarting_dcs_instances_or_clearing_dcs_instance_data
|
||||
querying_statistics_of_all_running_instances
|
||||
querying_dcs_instance_status
|
||||
changing_the_password_of_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
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 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.
|
||||
=========== ===================================
|
||||
26
api-ref/source/lifecycle_management_apis/index.rst
Normal file
26
api-ref/source/lifecycle_management_apis/index.rst
Normal file
@ -0,0 +1,26 @@
|
||||
:original_name: dcs-api-0312003.html
|
||||
|
||||
.. _dcs-api-0312003:
|
||||
|
||||
Lifecycle Management APIs
|
||||
=========================
|
||||
|
||||
- :ref:`Creating a DCS Instance <dcs-api-0312004>`
|
||||
- :ref:`Deleting a Single DCS Instance <dcs-api-0312008>`
|
||||
- :ref:`Batch Deleting DCS Instances <dcs-api-0312009>`
|
||||
- :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:`Scaling Up a DCS Instance <dcs-api-0312010>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_dcs_instance
|
||||
deleting_a_single_dcs_instance
|
||||
batch_deleting_dcs_instances
|
||||
querying_a_dcs_instance
|
||||
querying_all_dcs_instances_of_a_tenant
|
||||
modifying_information_about_a_dcs_instance
|
||||
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,96 @@
|
||||
: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. |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| spec_code | String | Yes | DCS instance specification code. |
|
||||
| | | | |
|
||||
| | | | This parameter is optional for DCS Redis 3.0 instances. |
|
||||
| | | | |
|
||||
| | | | This parameter is mandatory for DCS Redis 4.0 and Redis 5.0 instances. |
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
**Example request**
|
||||
|
||||
- Request URL:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/extend
|
||||
|
||||
- Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"spec_code":"redis.single.au1.large.4",
|
||||
"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 Scale-up task submitted successfully.
|
||||
=========== =====================================
|
||||
File diff suppressed because it is too large
Load Diff
16
api-ref/source/network_security/index.rst
Normal file
16
api-ref/source/network_security/index.rst
Normal file
@ -0,0 +1,16 @@
|
||||
:original_name: topic_300000009.html
|
||||
|
||||
.. _topic_300000009:
|
||||
|
||||
Network Security
|
||||
================
|
||||
|
||||
- :ref:`Configuring IP Whitelist Groups <updateipwhitelist>`
|
||||
- :ref:`Querying the IP Whitelist of a DCS Instance <showipwhitelist>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
configuring_ip_whitelist_groups
|
||||
querying_the_ip_whitelist_of_a_dcs_instance
|
||||
File diff suppressed because it is too large
Load Diff
20
api-ref/source/other_apis/index.rst
Normal file
20
api-ref/source/other_apis/index.rst
Normal file
@ -0,0 +1,20 @@
|
||||
:original_name: dcs-api-0312038.html
|
||||
|
||||
.. _dcs-api-0312038:
|
||||
|
||||
Other APIs
|
||||
==========
|
||||
|
||||
- :ref:`Querying Service Specifications <dcs-api-0312040>`
|
||||
- :ref:`Querying the Quota of a Tenant <dcs-api-0312036>`
|
||||
- :ref:`Querying Maintenance Time Window <dcs-api-0312041>`
|
||||
- :ref:`Querying AZ Information <dcs-api-0312039>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_service_specifications
|
||||
querying_the_quota_of_a_tenant
|
||||
querying_maintenance_time_window
|
||||
querying_az_information
|
||||
118
api-ref/source/other_apis/querying_az_information.rst
Normal file
118
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
388
api-ref/source/other_apis/querying_service_specifications.rst
Normal file
388
api-ref/source/other_apis/querying_service_specifications.rst
Normal file
File diff suppressed because it is too large
Load Diff
153
api-ref/source/other_apis/querying_the_quota_of_a_tenant.rst
Normal file
153
api-ref/source/other_apis/querying_the_quota_of_a_tenant.rst
Normal file
File diff suppressed because it is too large
Load Diff
16
api-ref/source/parameter_management_apis/index.rst
Normal file
16
api-ref/source/parameter_management_apis/index.rst
Normal file
@ -0,0 +1,16 @@
|
||||
:original_name: dcs-api-0312013.html
|
||||
|
||||
.. _dcs-api-0312013:
|
||||
|
||||
Parameter Management APIs
|
||||
=========================
|
||||
|
||||
- :ref:`Modifying Configuration Parameters <dcs-api-0312017>`
|
||||
- :ref:`Querying Configuration Parameters <dcs-api-0312015>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
modifying_configuration_parameters
|
||||
querying_configuration_parameters
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
BIN
umn/source/_static/images/en-us_image_0000001383077054.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001383077054.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 521 B |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
@ -14,59 +14,59 @@ The following lists the DCS operations that can be recorded by CTS.
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Operation | Resource Type | Trace Name |
|
||||
+========================================================+===============+======================================+
|
||||
| Creating an instance | DCS | createDCSInstance |
|
||||
| Creating an instance | Redis | createDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting an instance creation request | DCS | submitCreateDCSInstanceRequest |
|
||||
| Submitting an instance creation request | Redis | submitCreateDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Deleting multiple instances | DCS | batchDeleteDCSInstance |
|
||||
| Deleting multiple instances | Redis | batchDeleteDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Deleting an instance | DCS | deleteDCSInstance |
|
||||
| Deleting an instance | Redis | deleteDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Modifying instance information | DCS | modifyDCSInstanceInfo |
|
||||
| Modifying instance information | Redis | modifyDCSInstanceInfo |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Modifying instance configurations | DCS | modifyDCSInstanceConfig |
|
||||
| Modifying instance configurations | Redis | modifyDCSInstanceConfig |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Changing instance password | DCS | modifyDCSInstancePassword |
|
||||
| Changing instance password | Redis | modifyDCSInstancePassword |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Restarting an instance | DCS | restartDCSInstance |
|
||||
| Restarting an instance | Redis | restartDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting an instance restarting request | DCS | submitRestartDCSInstanceRequest |
|
||||
| Submitting an instance restarting request | Redis | submitRestartDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Starting an instance | DCS | startDCSInstance |
|
||||
| Starting an instance | Redis | startDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting an instance starting request | DCS | submitStartDCSInstanceRequest |
|
||||
| Submitting an instance starting request | Redis | submitStartDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Clearing instance data | DCS | flushDCSInstance |
|
||||
| Clearing instance data | Redis | flushDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Restarting instances in batches | DCS | batchRestartDCSInstance |
|
||||
| Restarting instances in batches | Redis | batchRestartDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting a request to restart instances in batches | DCS | submitBatchRestartDCSInstanceRequest |
|
||||
| Submitting a request to restart instances in batches | Redis | submitBatchRestartDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Starting multiple instances | DCS | batchStartDCSInstance |
|
||||
| Starting multiple instances | Redis | batchStartDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting a request to start instances in batches | DCS | submitBatchStartDCSInstanceRequest |
|
||||
| Submitting a request to start instances in batches | Redis | submitBatchStartDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Restoring instance data | DCS | restoreDCSInstance |
|
||||
| Restoring instance data | Redis | restoreDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting a request to restore instance data | DCS | submitRestoreDCSInstanceRequest |
|
||||
| Submitting a request to restore instance data | Redis | submitRestoreDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Backing up instance data | DCS | backupDCSInstance |
|
||||
| Backing up instance data | Redis | backupDCSInstance |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting a request to back up instance data | DCS | submitBackupDCSInstanceRequest |
|
||||
| Submitting a request to back up instance data | Redis | submitBackupDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Deleting instance backup files | DCS | deleteInstanceBackupFile |
|
||||
| Deleting instance backup files | Redis | deleteInstanceBackupFile |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Deleting background tasks | DCS | deleteDCSInstanceJobRecord |
|
||||
| Deleting background tasks | Redis | deleteDCSInstanceJobRecord |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Modifying instance specifications | DCS | modifySpecification |
|
||||
| Modifying instance specifications | Redis | modifySpecification |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting a request to modify instance specifications | DCS | submitModifySpecificationRequest |
|
||||
| Submitting a request to modify instance specifications | Redis | submitModifySpecificationRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Creating an instance subscription order | DCS | createInstanceOrder |
|
||||
| Creating an instance subscription order | Redis | createInstanceOrder |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Switching between master and standby nodes | DCS | masterStandbySwitchover |
|
||||
| Switching between master and standby nodes | Redis | masterStandbySwitchover |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Resetting instance password | DCS | resetDCSInstancePassword |
|
||||
| Resetting instance password | Redis | resetDCSInstancePassword |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
| Submitting a request to clear instance data | DCS | submitFlushDCSInstanceRequest |
|
||||
| Submitting a request to clear instance data | Redis | submitFlushDCSInstanceRequest |
|
||||
+--------------------------------------------------------+---------------+--------------------------------------+
|
||||
|
||||
@ -8,6 +8,20 @@ Change History
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Released On | What's New |
|
||||
+===================================+===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
|
||||
| 2022-10-19 | Added the following FAQs: |
|
||||
| | |
|
||||
| | :ref:`Why Does a Key Disappear in Redis? <dcs-faq-210409001>` |
|
||||
| | |
|
||||
| | :ref:`Will Cached Data Be Retained After an Instance Is Restarted? <dcs-faq-0220330>` |
|
||||
| | |
|
||||
| | :ref:`How Do I View Current Concurrent Connections and Maximum Connections of a DCS Redis Instance? <dcs-faq-0427070>` |
|
||||
| | |
|
||||
| | :ref:`Why Is the Rejected Connections Metric Displayed? <dcs-faq-0603001>` |
|
||||
| | |
|
||||
| | :ref:`Why Is Flow Control Triggered? How Do I Handle It? <dcs-faq-0220721>` |
|
||||
| | |
|
||||
| | :ref:`Analysis of Big Keys and Hot Keys <dcs-faq-0805001>` |
|
||||
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2022-08-29 | Modified the following content: |
|
||||
| | |
|
||||
| | Added description about security groups and whitelist configuration in sections :ref:`Creating a DCS Redis Instance <dcs-ug-0326008>`, :ref:`Security Group Configurations <en-us_topic_0090662012>`, :ref:`What Should I Do If an Error Is Returned When I Use the Jedis Connection Pool? <dcs-faq-0730006>`, :ref:`How Do I Troubleshoot Redis Connection Failures? <dcs-faq-0730010>`, and :ref:`Why Aren't Security Groups Configured for DCS Redis 4.0 and 5.0 Instances? <dcs-faq-0730014>` |
|
||||
|
||||
@ -94,6 +94,9 @@ html_title = "Distributed Cache Service - User Guide"
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Do not include sources into the rendered results
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
('index',
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
:original_name: dcs-faq-0521006.html
|
||||
|
||||
.. _dcs-faq-0521006:
|
||||
|
||||
How Do I Analyze the Hot Keys of a DCS Redis 3.0 Instance?
|
||||
==========================================================
|
||||
|
||||
DCS for Redis 3.0 does not support hot key analysis on the console. Alternatively, you can use the following methods to analyze hot keys:
|
||||
|
||||
- Method 1: Analyze the service structure and service implementation to discover possible hot keys.
|
||||
|
||||
For example, hot keys can be easily found in the service code during flash sales or user logins.
|
||||
|
||||
Advantage: Simple and easy to implement.
|
||||
|
||||
Disadvantage: Requires familiarity with the service code. In addition, the analysis become more difficult as the service scenarios become more complex.
|
||||
|
||||
- Method 2: Collect key access statistics in the client code to discover hot keys.
|
||||
|
||||
Disadvantage: Requires intrusive code modification.
|
||||
|
||||
- Method 3: Capture and analyze packets.
|
||||
|
||||
Advantage: Simple and easy to implement.
|
||||
@ -0,0 +1,42 @@
|
||||
:original_name: dcs-faq-0521005.html
|
||||
|
||||
.. _dcs-faq-0521005:
|
||||
|
||||
How Do I Avoid Big Keys and Hot Keys?
|
||||
=====================================
|
||||
|
||||
- **Keep the size of Strings within 10 KB** and **the quantity** of Hashes, Lists, Sets, or Zsets **within 5000**.
|
||||
- When naming keys, use the service name abbreviation as the prefix and do not use special characters such as spaces, line brakes, single or double quotation marks, and other escape characters.
|
||||
- Do not rely too much on Redis transactions.
|
||||
- The performance of short connections ("connect" in Redis terminology) is poor. Use clients with connection pools.
|
||||
- Do not enable data persistence if you use Redis just for caching and can tolerate data loss.
|
||||
- For details about how to optimize big keys and hot keys, see the following table.
|
||||
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Category | Method |
|
||||
+===================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================+
|
||||
| Big key | **Split big keys.** |
|
||||
| | |
|
||||
| | Scenarios: |
|
||||
| | |
|
||||
| | - **If the big key is a String**, you can split it into several key-value pairs and use **MGET** or a pipeline consisting of multiple **GET** operations to obtain the values. In this way, the pressure of a single operation can be split. For a cluster instance, the operation pressure can be evenly distributed to multiple shards, reducing the impact on a single shard. |
|
||||
| | - **If the big key contains multiple elements, and the elements must be operated together**, the big key cannot be split. You can remove the big key from Redis and store it on other storage media instead. This scenario should be avoided by design. |
|
||||
| | - **If the big key contains multiple elements, and only some elements need to be operated each time**, separate the elements. Take a Hash key as an example. Each time you run the **HGET** or **HSET** command, the result of the hash value modulo *N* (customized on the client) determines which key the field falls on. This algorithm is similar to that used for calculating slots in Redis Cluster. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | **Store big keys on other storage media.** |
|
||||
| | |
|
||||
| | If a big key cannot be split, it is not suitable to be stored in Redis. You can store it on other storage media, and delete the big key from Redis. |
|
||||
| | |
|
||||
| | .. caution:: |
|
||||
| | |
|
||||
| | CAUTION: |
|
||||
| | Do not use the **DEL** command to delete big keys. Otherwise, Redis may be blocked or even a master/standby switchover may occur. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Hot key | **Use the client cache or local cache.** |
|
||||
| | |
|
||||
| | If you know what keys are frequently used, you can design a two-level cache architecture (client/local cache and remote Redis). Frequently used data is obtained from the local cache first. The local cache and remote cache are updated with data writes at the same time. In this way, the read pressure on frequently accessed data can be separated. This method is costly because it requires changes to the client architecture and code. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | **Design a circuit breaker or degradation mechanism.** |
|
||||
| | |
|
||||
| | Hot keys can easily result in cache breakdown. During peak hours, requests are passed through to the backend database, causing service avalanche. To ensure availability, the system must have a circuit breaker or degradation mechanism to limit the traffic and degrade services if breakdown occurs. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
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