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

Compare commits

base: ahmet.yildirim:main
Branches Tags
ahmet.yildirim:main
ahmet.yildirim:propose-dcs_api-ref-635
ahmet.yildirim:propose-dcs_umn-599
ahmet.yildirim:propose-dcs_umn-589
ahmet.yildirim:propose-dcs_umn-576
ahmet.yildirim:propose-dcs_umn-569
ahmet.yildirim:propose-dcs_api-ref-569
ahmet.yildirim:propose-dcs_api-ref-565
ahmet.yildirim:tox4-cleanup
ahmet.yildirim:tox4
ahmet.yildirim:propose-dcs_umn-488
ahmet.yildirim:propose-dcs_umn-519
ahmet.yildirim:propose-dcs_api-ref-490
ahmet.yildirim:propose-dcs_umn-484
ahmet.yildirim:propose-dcs_api-ref-481
ahmet.yildirim:propose-dcs_umn-480
ahmet.yildirim:propose-dcs_umn-260
ahmet.yildirim:propose-dcs_api-ref-261
ahmet.yildirim:x4
ahmet.yildirim:x2
ahmet.yildirim:propose-dcs_umn-412
ahmet.yildirim:propose-dcs_api-ref-412
ahmet.yildirim:confpy-2
ahmet.yildirim:propose-dcs_umn-371
ahmet.yildirim:propose-dcs_api-ref-371
..
compare: ahmet.yildirim:propose-dcs_api-ref-481
Branches Tags
ahmet.yildirim:main
ahmet.yildirim:propose-dcs_api-ref-635
ahmet.yildirim:propose-dcs_umn-599
ahmet.yildirim:propose-dcs_umn-589
ahmet.yildirim:propose-dcs_umn-576
ahmet.yildirim:propose-dcs_umn-569
ahmet.yildirim:propose-dcs_api-ref-569
ahmet.yildirim:propose-dcs_api-ref-565
ahmet.yildirim:tox4-cleanup
ahmet.yildirim:tox4
ahmet.yildirim:propose-dcs_umn-488
ahmet.yildirim:propose-dcs_umn-519
ahmet.yildirim:propose-dcs_api-ref-490
ahmet.yildirim:propose-dcs_umn-484
ahmet.yildirim:propose-dcs_api-ref-481
ahmet.yildirim:propose-dcs_umn-480
ahmet.yildirim:propose-dcs_umn-260
ahmet.yildirim:propose-dcs_api-ref-261
ahmet.yildirim:x4
ahmet.yildirim:x2
ahmet.yildirim:propose-dcs_umn-412
ahmet.yildirim:propose-dcs_api-ref-412
ahmet.yildirim:confpy-2
ahmet.yildirim:propose-dcs_umn-371
ahmet.yildirim:propose-dcs_api-ref-371

1 Commits
main ... propose-dc

Author SHA1 Message Date
OpenTelekomCloud Proposal Bot
0c535741ce Update content 2022-11-22 07:46:07 +00:00
302 changed files with 1915 additions and 13453 deletions
Show Stats Expand all files Collapse all files

0
api-ref/source/_static/images/en-us_image_0216824199.jpg → api-ref/source/_static/images/en-us_image_0000001287593560.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB

12
api-ref/source/backup_and_restoration_apis/backing_up_a_dcs_instance.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/backing_up_a_dcs_instance.rst
View File

@ -51,14 +51,10 @@ Request
**Example request** **Example request**
- Request URL:
.. code-block:: text .. code-block:: text
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups
- Example:
.. code-block:: .. code-block::
{ {
@ -99,8 +95,8 @@ Status Code
.. table:: **Table 4** Status code .. table:: **Table 4** Status code
=========== ================================= =========== ==============================================
Status Code Description Status Code Description
=========== ================================= =========== ==============================================
200 Backup task created successfully. 200 Specified DCS instance backed up successfully.
=========== ================================= =========== ==============================================

25
api-ref/source/instance_management_apis/changing_the_password_of_a_dcs_instance.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/changing_the_password_of_a_dcs_instance.rst
View File

@ -39,36 +39,31 @@ Request
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+-----------------+-----------------+-----------------+--------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description | | Parameter | Type | Mandatory | Description |
+=================+=================+=================+====================================================================+ +=================+=================+=================+=========================================================================+
| old_password | String | Yes | Old password. | | old_password | String | Yes | Old password. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
| new_password | String | Yes | New password. | | new_password | String | Yes | New password. |
| | | | | | | | | |
| | | | Password complexity requirements: | | | | | Password complexity requirements: |
| | | | | | | | | |
| | | | - Cannot be empty. | | | | | - Must be a string consisting of 8 to 32 characters. |
| | | | - Cannot be the username or the username spelled backwards. | | | | | - Must be different from the old password. |
| | | | - Can be 8 to 32 characters long. | | | | | - Contains at least three of the following character types: |
| | | | - Contain at least three of the following character types: |
| | | | | | | | | |
| | | | - Lowercase letters | | | | | - Lowercase letters |
| | | | - Uppercase letters | | | | | - Uppercase letters |
| | | | - Digits | | | | | - Digits |
| | | | - Special characters (:literal:`\`~!@#$^&*()-_=+\\|{}:,<.>/?`) | | | | | - Special characters (:literal:`\`~!@#$%^&*()-_=+\\|[{}]:'",<.>/?`) |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
**Example request** **Example request**
- Request URL:
.. code-block:: text .. code-block:: text
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password
- Example:
.. code-block:: .. code-block::
{ {
@ -110,9 +105,9 @@ Response
.. code-block:: .. code-block::
//Change password success. //Change password sucessful.
{ {
"result" : "Success", "result" : "success",
"message" : "Modify DCSInstance password success.", "message" : "Modify DCSInstance password success.",
"retry_times_left" : "5", "retry_times_left" : "5",
"lock_time" : "0", "lock_time" : "0",

14
api-ref/source/backup_and_restoration_apis/deleting_backup_files.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/deleting_backup_files.rst
View File

@ -24,23 +24,27 @@ DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
=========== ====== ========= ======================= =========== ====== ========= =======================
Parameter Type Mandatory Description Parameter Type Mandatory Description
=========== ====== ========= ======================= =========== ====== ========= =======================
project_id String Yes Project ID. project_id String Yes Project ID
instance_id String Yes DCS instance ID instance_id String Yes DCS instance ID
backup_id String Yes ID of the backup record 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
------- -------
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
.. code-block:: text None.
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
Response Response
-------- --------

34
api-ref/source/apis_used_for_maintaining_dcs_instances/index.rst Normal file
View File

@ -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

14
api-ref/source/parameter_management_apis/modifying_configuration_parameters.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/modifying_dcs_instance_configuration_parameters.rst
View File

@ -2,14 +2,16 @@
.. _dcs-api-0312017: .. _dcs-api-0312017:
Modifying Configuration Parameters Modifying DCS Instance Configuration Parameters
================================== ===============================================
Function Function
-------- --------
You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements. You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.
Currently, you can only modify configuration parameters for single-node and master/standby instances in the **Running** state.
URI URI
--- ---
@ -61,14 +63,10 @@ For possible values of parameters in :ref:`Table 3 <dcs-api-0312017__table352152
**Example request** **Example request**
- Request URL:
.. code-block:: text .. code-block:: text
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
- Example:
.. code-block:: .. code-block::
{ {
@ -86,11 +84,11 @@ Response
**Response parameters** **Response parameters**
None None.
**Example response** **Example response**
None None.
Status Code Status Code
----------- -----------

5
api-ref/source/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/querying_dcs_instance_backup_records.rst
View File

@ -42,7 +42,7 @@ Request
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
@ -110,8 +110,6 @@ Response
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| backup_name | String | Name of the backup record | | backup_name | String | Name of the backup record |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| backup_format | String | Backup format. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| error_code | String | Error code returned if DCS instance backup fails. For details about error codes, see :ref:`Table 4 <dcs-api-0312022__table1255361919491>`. | | error_code | String | Error code returned if DCS instance backup fails. For details about error codes, see :ref:`Table 4 <dcs-api-0312022__table1255361919491>`. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
| is_support_restore | String | An indicator of whether restoration is supported. Options: **TRUE** or **FALSE**. | | is_support_restore | String | An indicator of whether restoration is supported. Options: **TRUE** or **FALSE**. |
@ -159,7 +157,6 @@ Response
"updated_at": "2019-05-10T08:32:30.546Z", "updated_at": "2019-05-10T08:32:30.546Z",
"execution_at": "2019-05-10T08:31:21.461Z", "execution_at": "2019-05-10T08:31:21.461Z",
"backup_type": "manual", "backup_type": "manual",
"backup_format": "AOF",
"backup_name": "backup_20190510163116", "backup_name": "backup_20190510163116",
"error_code": null, "error_code": null,
"is_support_restore": "TRUE" "is_support_restore": "TRUE"

311
api-ref/source/apis_used_for_maintaining_dcs_instances/querying_dcs_instance_configuration_parameters.rst Normal file
View File

File diff suppressed because it is too large Load Diff

8
api-ref/source/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/querying_dcs_instance_restoration_records.rst
View File

@ -42,7 +42,7 @@ Request
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
@ -98,10 +98,6 @@ Response
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| backup_name | String | Name of the backup record | | backup_name | String | Name of the backup record |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| sourceInstanceID | String | Source instance ID. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| sourceInstanceName | String | Source instance name. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| error_code | String | Error code returned if DCS instance restoration fails. For details about error codes, see :ref:`Table 4 <dcs-api-0312022__table1255361919491>`. | | error_code | String | Error code returned if DCS instance restoration fails. For details about error codes, see :ref:`Table 4 <dcs-api-0312022__table1255361919491>`. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
@ -122,8 +118,6 @@ Response
"updated_at": "2017-07-18T21:41:35.182Z", "updated_at": "2017-07-18T21:41:35.182Z",
"restore_name": "restore_20170718214120", "restore_name": "restore_20170718214120",
"backup_name": "backup_20170718000002", "backup_name": "backup_20170718000002",
"sourceInstanceId":"dcb96c22-fd6f-41c0-88b5-544784558dd9",
"sourceInstanceName":"Test-DCS-MS-3-f79a983f",
"error_code": null "error_code": null
} }
], ],

98
api-ref/source/apis_used_for_maintaining_dcs_instances/querying_dcs_instance_status.rst Normal file
View File

@ -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. |
+-------------+-------------------------------------------------------------------------+

6
api-ref/source/instance_management_apis/querying_statistics_of_all_running_instances.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/querying_statistics_of_all_running_instances.rst
View File

@ -24,7 +24,7 @@ GET /v1.0/{project_id}/instances/statistic
========== ====== ========= =========== ========== ====== ========= ===========
Parameter Type Mandatory Description Parameter Type Mandatory Description
========== ====== ========= =========== ========== ====== ========= ===========
project_id String Yes Project ID. project_id String Yes Project ID
========== ====== ========= =========== ========== ====== ========= ===========
Request Request
@ -32,7 +32,7 @@ Request
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
@ -67,7 +67,7 @@ Response
keys Integer Number of cached data records keys Integer Number of cached data records
instance_id String DCS instance ID instance_id String DCS instance ID
used_memory Integer Size of the used memory in MB used_memory Integer Size of the used memory in MB
max_memory Integer Overall memory size in MB max_memory Integer Overall memory size in MB.
cmd_get_count Integer Number of times the GET command is run cmd_get_count Integer Number of times the GET command is run
cmd_set_count Integer Number of times the SET command is run cmd_set_count Integer Number of times the SET command is run
used_cpu String Percentage of CPU usage used_cpu String Percentage of CPU usage

34
api-ref/source/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/restarting_dcs_instances.rst
View File

@ -2,16 +2,14 @@
.. _dcs-api-0312018: .. _dcs-api-0312018:
Restarting DCS Instances or Clearing DCS Instance Data Restarting DCS Instances
====================================================== ========================
Function Function
-------- --------
This API is used to restart a running DCS instance. This API is used to restart a running DCS instance.
Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.
URI URI
--- ---
@ -40,28 +38,20 @@ Request
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+ +-----------+--------+-----------+--------------------------------------------------------+
| Parameter | Type | Mandatory | Description | | Parameter | Type | Mandatory | Description |
+=================+=================+=================+=========================================================================+ +===========+========+===========+========================================================+
| action | String | Yes | Action performed on DCS instances. Options: **restart**, and **flush**. | | action | String | Yes | Action performed on DCS instances. Value: **restart**. |
| | | | | +-----------+--------+-----------+--------------------------------------------------------+
| | | | .. note:: |
| | | | |
| | | | Only DCS Redis 4.0 and 5.0 instances can be flushed. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
| instances | Array | Yes | List of DCS instance IDs. | | instances | Array | Yes | List of DCS instance IDs. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+ +-----------+--------+-----------+--------------------------------------------------------+
**Example request** **Example request**
- Request URL:
.. code-block:: text .. code-block:: text
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status
- Example:
.. code-block:: .. code-block::
{ {
@ -120,8 +110,8 @@ Status Code
.. table:: **Table 5** Status code .. table:: **Table 5** Status code
+-------------+-------------------------------------------------------------------+ =========== ========================================
| Status Code | Description | Status Code Description
+=============+===================================================================+ =========== ========================================
| 200 | Successfully restarted DCS instance or cleared DCS instance data. | 200 Successfully restarted the DCS instance.
+-------------+-------------------------------------------------------------------+ =========== ========================================

8
api-ref/source/backup_and_restoration_apis/restoring_a_dcs_instance.rst → api-ref/source/apis_used_for_maintaining_dcs_instances/restoring_a_dcs_instance.rst
View File

@ -97,8 +97,8 @@ Status Code
.. table:: **Table 4** Status code .. table:: **Table 4** Status code
=========== ====================================== =========== ===================================
Status Code Description Status Code Description
=========== ====================================== =========== ===================================
200 Restoration task created successfully. 200 DCS instance restored successfully.
=========== ====================================== =========== ===================================

2
api-ref/source/lifecycle_management_apis/batch_deleting_dcs_instances.rst → api-ref/source/apis_used_for_managing_dcs_instances/batch_deleting_dcs_instances.rst
View File

@ -77,7 +77,7 @@ Response
**Response parameters** **Response parameters**
If the value of the **allFailure** parameter in the URI is **false**, an empty response is then returned. If the value of the **allFailure** parameter in the URI is **true**, a response containing the parameter in :ref:`Table 3 <dcs-api-0312009__table18935105020414>` is returned. If the value of the **allFailure** parameter in the URI is **true**, all DCS instances that the tenant specified by **project_id** that failed to create are deleted and an empty response is then returned. If the value of the **allFailure** parameter in the URI is **false**, the DCS instances specified by the **instances** parameter in the API request are deleted and a response containing the parameter in :ref:`Table 3 <dcs-api-0312009__table18935105020414>` is then returned.
.. _dcs-api-0312009__table18935105020414: .. _dcs-api-0312009__table18935105020414:

283
api-ref/source/apis_used_for_managing_dcs_instances/creating_a_dcs_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

16
api-ref/source/lifecycle_management_apis/deleting_a_single_dcs_instance.rst → api-ref/source/apis_used_for_managing_dcs_instances/deleting_a_single_dcs_instance.rst
View File

@ -21,19 +21,19 @@ DELETE /v1.0/{project_id}/instances/{instance_id}
.. 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
instance_id String Yes Instance ID. instance_id String Yes DCS instance ID
=========== ====== ========= ============ =========== ====== ========= ===============
Request Request
------- -------
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
@ -48,11 +48,11 @@ Response
**Response parameters** **Response parameters**
None None.
**Example response** **Example response**
None None.
Status Code Status Code
----------- -----------

12
api-ref/source/lifecycle_management_apis/index.rst → api-ref/source/apis_used_for_managing_dcs_instances/index.rst
View File

@ -2,15 +2,15 @@
.. _dcs-api-0312003: .. _dcs-api-0312003:
Lifecycle Management APIs APIs Used for Managing DCS Instances
========================= ====================================
- :ref:`Creating a DCS Instance <dcs-api-0312004>` - :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 a DCS Instance <dcs-api-0312005>`
- :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>` - :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`
- :ref:`Modifying Information About a DCS Instance <dcs-api-0312007>` - :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>` - :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`
.. toctree:: .. toctree::
@ -18,9 +18,9 @@ Lifecycle Management APIs
:hidden: :hidden:
creating_a_dcs_instance creating_a_dcs_instance
deleting_a_single_dcs_instance
batch_deleting_dcs_instances
querying_a_dcs_instance querying_a_dcs_instance
querying_all_dcs_instances_of_a_tenant querying_all_dcs_instances_of_a_tenant
modifying_information_about_a_dcs_instance modifying_information_about_a_dcs_instance
deleting_a_single_dcs_instance
batch_deleting_dcs_instances
scaling_up_a_dcs_instance scaling_up_a_dcs_instance

16
api-ref/source/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst → api-ref/source/apis_used_for_managing_dcs_instances/modifying_information_about_a_dcs_instance.rst
View File

@ -10,8 +10,8 @@ Function
This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, and security group. This API is used to modify the information about a DCS instance, including the instance name, description, backup policy, start and end time of the maintenance window, and security group.
URI **URI**
--- -------
PUT /v1.0/{project_id}/instances/{instance_id} PUT /v1.0/{project_id}/instances/{instance_id}
@ -54,13 +54,13 @@ Request
| | | | | | | | | |
| | | | "\\" is defined as an escape character in the queue description. If you need to enter a backward slash (\\) or a double quotation mark (") in the queue description, enter **\\\\** or **\\"**. | | | | | "\\" is defined as an escape character in the queue description. If you need to enter a backward slash (\\) or a double quotation mark (") in the queue description, enter **\\\\** or **\\"**. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| instance_backup_policy | Object | No | Backup policy. | | instance_backup_policy | JSON | No | Backup policy. |
| | | | | | | | | |
| | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 <dcs-api-0312004__table12803218151513>` and :ref:`Table 4 <dcs-api-0312004__table187492037201518>`. | | | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 <dcs-api-0312004__table12803218151513>` and :ref:`Table 4 <dcs-api-0312004__table187492037201518>`. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maintain_begin | String | No | Time at which the maintenance time window starts. | | maintain_begin | String | No | Time at which the maintenance time window starts. |
| | | | | | | | | |
| | | | Format: hh:mm:ss. | | | | | Format: HH:mm:ss. |
| | | | | | | | | |
| | | | - The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see :ref:`Querying Maintenance Time Window <dcs-api-0312041>`. | | | | | - The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see :ref:`Querying Maintenance Time Window <dcs-api-0312041>`. |
| | | | - The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00. | | | | | - The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00. |
@ -68,7 +68,7 @@ Request
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| maintain_end | String | No | Time at which the maintenance time window ends. | | maintain_end | String | No | Time at which the maintenance time window ends. |
| | | | | | | | | |
| | | | Format: hh:mm:ss. | | | | | Format: HH:mm:ss. |
| | | | | | | | | |
| | | | - The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see :ref:`Querying Maintenance Time Window <dcs-api-0312041>`. | | | | | - The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see :ref:`Querying Maintenance Time Window <dcs-api-0312041>`. |
| | | | | | | | | |
@ -78,8 +78,6 @@ Request
| security_group_id | String | No | Security group ID. | | security_group_id | String | No | Security group ID. |
| | | | | | | | | |
| | | | The value can be obtained from the VPC console or the API. | | | | | The value can be obtained from the VPC console or the API. |
| | | | |
| | | | This parameter is supported only by DCS Redis 3.0 instances. |
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Example request** **Example request**
@ -131,11 +129,11 @@ Response
**Response parameters** **Response parameters**
None None.
**Example response** **Example response**
None None.
Status Code Status Code
----------- -----------

243
api-ref/source/apis_used_for_managing_dcs_instances/querying_a_dcs_instance.rst Normal file
View File

File diff suppressed because it is too large Load Diff

209
api-ref/source/apis_used_for_managing_dcs_instances/querying_all_dcs_instances_of_a_tenant.rst Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -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
View 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

34
api-ref/source/other_apis/querying_the_quota_of_a_tenant.rst → api-ref/source/apis_used_for_tenant_management/querying_the_quota_of_a_tenant.rst
View File

@ -24,7 +24,7 @@ GET /v1.0/{project_id}/quota
========== ====== ========= =========== ========== ====== ========= ===========
Parameter Type Mandatory Description Parameter Type Mandatory Description
========== ====== ========= =========== ========== ====== ========= ===========
project_id String Yes Project ID. project_id String Yes Project ID
========== ====== ========= =========== ========== ====== ========= ===========
Request Request
@ -32,11 +32,11 @@ Request
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
None None.
Response Response
-------- --------
@ -49,23 +49,23 @@ Response
.. table:: **Table 2** Parameter description .. table:: **Table 2** Parameter description
+-----------+--------+-----------+-------------------------------------------------------------------------------------------+ +-----------+------+-----------+-------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description | | Parameter | Type | Mandatory | Description |
+===========+========+===========+===========================================================================================+ +===========+======+===========+===========================================================================================+
| quotas | Object | Yes | Quota information. For details, see :ref:`Table 3 <dcs-api-0312036__table1341618240392>`. | | quotas | JSON | Yes | Quota information. For details, see :ref:`Table 3 <dcs-api-0312036__table1341618240392>`. |
+-----------+--------+-----------+-------------------------------------------------------------------------------------------+ +-----------+------+-----------+-------------------------------------------------------------------------------------------+
.. _dcs-api-0312036__table1341618240392: .. _dcs-api-0312036__table1341618240392:
.. table:: **Table 3** quotas parameter description .. table:: **Table 3** quotas parameter description
+---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+ +---------------+-------+-----------+------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description | | Parameter | Type | Mandatory | Description |
+===============+========+===========+============================================================================================================+ +===============+=======+===========+============================================================================================================+
| resources | Array | Yes | List of quotas. For details, see :ref:`Table 4 <dcs-api-0312036__table164180248392>`. | | resources | Array | Yes | List of quotas For details, see :ref:`Table 4 <dcs-api-0312036__table164180248392>`. |
+---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+ +---------------+-------+-----------+------------------------------------------------------------------------------------------------------------+
| resource_user | Object | Yes | Information about a resource tenant For details, see :ref:`Table 5 <dcs-api-0312036__table1641811248397>`. | | resource_user | JSON | Yes | Information about a resource tenant For details, see :ref:`Table 5 <dcs-api-0312036__table1641811248397>`. |
+---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+ +---------------+-------+-----------+------------------------------------------------------------------------------------------------------------+
.. _dcs-api-0312036__table164180248392: .. _dcs-api-0312036__table164180248392:
@ -99,12 +99,12 @@ Response
.. table:: **Table 5** resource_user parameter description .. table:: **Table 5** resource_user parameter description
=========== ====== ==================== =========== ======= ====================
Parameter Type Description Parameter Type Description
=========== ====== ==================== =========== ======= ====================
tenant_id String Resource tenant ID tenant_id String Resource tenant ID
tenant_name String Resource tenant name tenant_name Integer Resource tenant name
=========== ====== ==================== =========== ======= ====================
**Example response** **Example response**

830
api-ref/source/appendix/error_codes.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/appendix/obtaining_a_project_id.rst
View File

@ -19,7 +19,7 @@ The following procedure describes how to obtain a project ID:
On the **My Credential** page, view project IDs in the project list. On the **My Credential** page, view project IDs in the project list.
.. figure:: /_static/images/en-us_image_0216824199.jpg .. figure:: /_static/images/en-us_image_0000001287593560.jpg
:alt: **Figure 1** Viewing project IDs :alt: **Figure 1** Viewing project IDs
**Figure 1** Viewing project IDs **Figure 1** Viewing project IDs

42
api-ref/source/appendix/status_codes.rst
View File

File diff suppressed because it is too large Load Diff

22
api-ref/source/backup_and_restoration_apis/index.rst
View File

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

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

@ -5,53 +5,9 @@
Change History Change History
============== ==============
.. table:: **Table 1** Change history
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | What's New | | Released On | What's New |
+===================================+====================================================================================================================================================================================================================================================================================================================================+ +===================================+====================================================================================================================================================================================================================================================================================================================================+
| 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>`. |
| | - Deleted the **includeFailure** parameter from :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`. |
| | - Modified the description of the **maxmemory-policy** parameter in :ref:`Parameter Management APIs <dcs-api-0312013>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-08-04 | Modified the following content: |
| | |
| | - Optimized parameter description in :ref:`Creating a DCS Instance <dcs-api-0312004>` and :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`. |
| | - Added sections :ref:`Configuring IP Whitelist Groups <updateipwhitelist>` and :ref:`Querying the IP Whitelist of a DCS Instance <showipwhitelist>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-07-13 | Modified the following content: |
| | |
| | - Changed the **JSON** parameter type to **Object**. |
| | - Changed the **Enum** parameter type to **String**. |
| | - Added parameters **cluster_v1** and **node_role** in section :ref:`Querying Configuration Parameters <dcs-api-0312015>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2022-04-11 | Modified the following content: |
| | |
| | Added the **spec_code** parameter in section :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2021-06-30 | Modified the following content: |
| | |
| | - Optimized response parameters and examples in section :ref:`Querying a DCS Instance <dcs-api-0312005>`. |
| | - Optimized response parameters and examples in section :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`. |
| | - Optimized response parameters and examples in section :ref:`Querying DCS Instance Status <dcs-api-0312016>`. |
| | - Added the **sourceInstanceId** and **sourceInstanceName** parameters in section :ref:`Querying DCS Instance Restoration Records <dcs-api-0312023>`. |
| | - Added the **backup_format** parameter in section :ref:`Querying DCS Instance Backup Records <dcs-api-0312022>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2021-04-14 | Modified the following content: |
| | |
| | - Added options for the **capacity** parameter supported by single-node and master/standby DCS Redis 3.0 instances in section :ref:`Creating a DCS Instance <dcs-api-0312004>`. |
| | - Added the description about configuration parameters supported by different instances in section :ref:`Querying Configuration Parameters <dcs-api-0312015>`. |
| | |
| | - Added options for the **spec_code** parameter in section :ref:`Querying Service Specifications <dcs-api-0312040>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-09-30 | Modified the following content: |
| | |
| | - 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>`. |
| | - Optimized :ref:`Error Codes <dcs-api-0312044>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 section :ref:`Error Codes <dcs-api-0312044>`. |
@ -79,7 +35,7 @@ Change History
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2018-03-16 | Modified the following content: | | 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 Configuration Parameters <dcs-api-0312015>`. | | | - 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. | | | - Changed instance password complexity rules. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2017-11-08 | Modified the following content: | | 2017-11-08 | Modified the following content: |
@ -92,7 +48,7 @@ Change History
| | - Added sections :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. | | | - 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 sections :ref:`Backing Up a DCS Instance <dcs-api-0312020>` to :ref:`Deleting Backup Files <dcs-api-0312024>`. |
| | - Added the **Time Window** parameter. | | | - Added the **Time Window** parameter. |
| | - Added two Redis parameters **maxclients** and **reserved-memory** in section :ref:`Querying Configuration Parameters <dcs-api-0312015>`. | | | - 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>`. | | | - Added some error codes and their description in chapter :ref:`Error Codes <dcs-api-0312044>`. |
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2017-05-30 | Modified the following content: | | 2017-05-30 | 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',

237
api-ref/source/data_migration_apis/creating_a_data_migration_task.rst
View File

File diff suppressed because it is too large Load Diff

14
api-ref/source/data_migration_apis/index.rst
View File

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

9
api-ref/source/index.rst
View File

@ -6,12 +6,9 @@ Distributed Cache Service - API Reference
:maxdepth: 1 :maxdepth: 1
api_usage_guidelines api_usage_guidelines
lifecycle_management_apis/index apis_used_for_managing_dcs_instances/index
instance_management_apis/index apis_used_for_maintaining_dcs_instances/index
parameter_management_apis/index apis_used_for_tenant_management/index
data_migration_apis/index
backup_and_restoration_apis/index
network_security/index
other_apis/index other_apis/index
appendix/index appendix/index
change_history change_history

20
api-ref/source/instance_management_apis/index.rst
View File

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

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

File diff suppressed because it is too large Load Diff

340
api-ref/source/lifecycle_management_apis/creating_a_dcs_instance.rst
View File

File diff suppressed because it is too large Load Diff

365
api-ref/source/lifecycle_management_apis/querying_a_dcs_instance.rst
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

96
api-ref/source/lifecycle_management_apis/scaling_up_a_dcs_instance.rst
View File

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

201
api-ref/source/network_security/configuring_ip_whitelist_groups.rst
View File

File diff suppressed because it is too large Load Diff

16
api-ref/source/network_security/index.rst
View File

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

101
api-ref/source/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst
View File

File diff suppressed because it is too large Load Diff

10
api-ref/source/other_apis/index.rst
View File

@ -5,16 +5,14 @@
Other APIs 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>` - :ref:`Querying AZ Information <dcs-api-0312039>`
- :ref:`Querying Service Specifications <dcs-api-0312040>`
- :ref:`Querying Maintenance Time Window <dcs-api-0312041>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
querying_service_specifications
querying_the_quota_of_a_tenant
querying_maintenance_time_window
querying_az_information querying_az_information
querying_service_specifications
querying_maintenance_time_window

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

@ -20,11 +20,11 @@ Request
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
None None.
Response Response
-------- --------
@ -49,27 +49,22 @@ Response
.. table:: **Table 2** Parameter description of the available_zones array .. table:: **Table 2** Parameter description of the available_zones array
+----------------------------+-----------------------+------------------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+============================+=======================+====================================================================================+ +=======================+=======================+==================================================================+
| id | String | AZ ID. | | id | String | AZ ID. |
+----------------------------+-----------------------+------------------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------+
| code | String | AZ code. | | code | String | AZ code. |
+----------------------------+-----------------------+------------------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------+
| name | String | AZ name. | | name | String | AZ name. |
+----------------------------+-----------------------+------------------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------+
| port | String | Port number of the AZ. | | port | String | Port number of the AZ. |
+----------------------------+-----------------------+------------------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------+
| resource_availability | String | An indicator of whether there are available Redis 3.0 resources in the AZ. | | resource_availability | String | An indicator of whether there are available resources in the AZ. |
| | | | | | | |
| | | - **true**: There are available resources in the AZ. | | | | - **true**: There are available resources in the AZ. |
| | | - **false**: There are no available resources in the AZ. | | | | - **false**: All resources have been used up in the AZ. |
+----------------------------+-----------------------+------------------------------------------------------------------------------------+ +-----------------------+-----------------------+------------------------------------------------------------------+
| resource_availability_dcs2 | String | An indicator of whether there are available Redis 4.0 and 5.0 resources in the AZ. |
| | | |
| | | - **true**: There are available resources in the AZ. |
| | | - **false**: There are no available resources in the AZ. |
+----------------------------+-----------------------+------------------------------------------------------------------------------------+
**Example response** **Example response**

4
api-ref/source/other_apis/querying_maintenance_time_window.rst
View File

@ -20,11 +20,11 @@ Request
**Request parameters** **Request parameters**
None None.
**Example request** **Example request**
None None.
Response Response
-------- --------

286
api-ref/source/other_apis/querying_service_specifications.rst
View File

File diff suppressed because it is too large Load Diff

16
api-ref/source/parameter_management_apis/index.rst
View File

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

805
api-ref/source/parameter_management_apis/querying_configuration_parameters.rst
View File

File diff suppressed because it is too large Load Diff

62
tox.ini
View File

File diff suppressed because it is too large Load Diff

BIN
umn/source/_static/images/en-us_image_0000001148443450.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1004 B

BIN
umn/source/_static/images/en-us_image_0000001148443456.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1004 B

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