Compare commits
11 Commits
propose-dc
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| d0a20ad66d | |||
| e50e044f87 | |||
| 0c129c6fd6 | |||
|
3bfe43b812 | ||
|
|
4bf79b0c29 | ||
|
|
6cb8d28391 | ||
|
|
d5a1e18a55 | ||
| 9d00de4510 | |||
| bfd0af1912 | |||
| 3a9c34d473 | |||
| 6f443bfc8c |
|
Before Width: | Height: | Size: 110 KiB After Width: | Height: | Size: 110 KiB |
@ -1,34 +0,0 @@
|
||||
:original_name: dcs-api-0312013.html
|
||||
|
||||
.. _dcs-api-0312013:
|
||||
|
||||
APIs Used for Maintaining DCS Instances
|
||||
=======================================
|
||||
|
||||
- :ref:`Querying Statistics of All Running Instances <dcs-api-0312014>`
|
||||
- :ref:`Querying DCS Instance Configuration Parameters <dcs-api-0312015>`
|
||||
- :ref:`Querying DCS Instance Status <dcs-api-0312016>`
|
||||
- :ref:`Modifying DCS Instance Configuration Parameters <dcs-api-0312017>`
|
||||
- :ref:`Restarting DCS Instances <dcs-api-0312018>`
|
||||
- :ref:`Changing the Password of a DCS Instance <dcs-api-0312019>`
|
||||
- :ref:`Backing Up a DCS Instance <dcs-api-0312020>`
|
||||
- :ref:`Restoring a DCS Instance <dcs-api-0312021>`
|
||||
- :ref:`Querying DCS Instance Backup Records <dcs-api-0312022>`
|
||||
- :ref:`Querying DCS Instance Restoration Records <dcs-api-0312023>`
|
||||
- :ref:`Deleting Backup Files <dcs-api-0312024>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_statistics_of_all_running_instances
|
||||
querying_dcs_instance_configuration_parameters
|
||||
querying_dcs_instance_status
|
||||
modifying_dcs_instance_configuration_parameters
|
||||
restarting_dcs_instances
|
||||
changing_the_password_of_a_dcs_instance
|
||||
backing_up_a_dcs_instance
|
||||
restoring_a_dcs_instance
|
||||
querying_dcs_instance_backup_records
|
||||
querying_dcs_instance_restoration_records
|
||||
deleting_backup_files
|
||||
File diff suppressed because it is too large
Load Diff
@ -1,98 +0,0 @@
|
||||
:original_name: dcs-api-0312016.html
|
||||
|
||||
.. _dcs-api-0312016:
|
||||
|
||||
Querying DCS Instance Status
|
||||
============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to query the number of instances in different states.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}
|
||||
|
||||
:ref:`Table 1 <dcs-api-0312016__table1624017336377>` describes the parameters.
|
||||
|
||||
.. _dcs-api-0312016__table1624017336377:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+=================+=================+=================+============================================================================================================================+
|
||||
| project_id | String | Yes | Project ID. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| includeFailure | String | No | An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options: |
|
||||
| | | | |
|
||||
| | | | - **true**: The number of DCS instances that failed to be created will be returned to the API caller. |
|
||||
| | | | - **false** or others: The number of DCS instances that failed to be created will not be returned to the API caller. |
|
||||
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?includeFailure=true
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
**Response parameters**
|
||||
|
||||
:ref:`Table 2 <dcs-api-0312016__table595111370375>` describes the response parameters.
|
||||
|
||||
.. _dcs-api-0312016__table595111370375:
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
================== ======= =============================================
|
||||
Parameter Type Description
|
||||
================== ======= =============================================
|
||||
creating_count Integer Number of instances that are being created.
|
||||
deleting_count Integer Number of instances that are being deleted.
|
||||
running_count Integer Number of running instances.
|
||||
error_count Integer Number of abnormal instances.
|
||||
restarting_count Integer Number of instances that are being restarted.
|
||||
createfailed_count Integer Number of instances that fail to be created.
|
||||
extending_count Integer Number of instances that are being scaled up.
|
||||
================== ======= =============================================
|
||||
|
||||
**Example response**
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"extending_count": 0,
|
||||
"creating_count": 0,
|
||||
"deleting_count": 0,
|
||||
"running_count": 16,
|
||||
"error_count": 0,
|
||||
"restarting_count": 0,
|
||||
"createfailed_count": 44
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
:ref:`Table 3 <dcs-api-0312016__table36591653133>` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 <dcs-api-0312043__table5210141351517>`.
|
||||
|
||||
.. _dcs-api-0312016__table36591653133:
|
||||
|
||||
.. table:: **Table 3** Status code
|
||||
|
||||
+-------------+-------------------------------------------------------------------------+
|
||||
| Status Code | Description |
|
||||
+=============+=========================================================================+
|
||||
| 200 | Quantities of DCS instances in different statuses queried successfully. |
|
||||
+-------------+-------------------------------------------------------------------------+
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,84 +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. |
|
||||
+--------------+---------+-----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
**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.
|
||||
=========== ====================================
|
||||
@ -1,14 +0,0 @@
|
||||
:original_name: dcs-api-0312035.html
|
||||
|
||||
.. _dcs-api-0312035:
|
||||
|
||||
APIs Used for Tenant Management
|
||||
===============================
|
||||
|
||||
- :ref:`Querying the Quota of a Tenant <dcs-api-0312036>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_the_quota_of_a_tenant
|
||||
File diff suppressed because it is too large
Load Diff
@ -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.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001287593560.jpg
|
||||
.. figure:: /_static/images/en-us_image_0216824199.jpg
|
||||
:alt: **Figure 1** Viewing project IDs
|
||||
|
||||
**Figure 1** Viewing project IDs
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -51,15 +51,19 @@ Request
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
- Request URL:
|
||||
|
||||
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups
|
||||
.. code-block:: text
|
||||
|
||||
.. code-block::
|
||||
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups
|
||||
|
||||
{
|
||||
"remark": "Backup instances"
|
||||
}
|
||||
- Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"remark": "Backup instances"
|
||||
}
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -95,8 +99,8 @@ Status Code
|
||||
|
||||
.. table:: **Table 4** Status code
|
||||
|
||||
=========== ==============================================
|
||||
=========== =================================
|
||||
Status Code Description
|
||||
=========== ==============================================
|
||||
200 Specified DCS instance backed up successfully.
|
||||
=========== ==============================================
|
||||
=========== =================================
|
||||
200 Backup task created successfully.
|
||||
=========== =================================
|
||||
@ -24,27 +24,23 @@ DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
|
||||
=========== ====== ========= =======================
|
||||
Parameter Type Mandatory Description
|
||||
=========== ====== ========= =======================
|
||||
project_id String Yes Project ID
|
||||
project_id String Yes Project ID.
|
||||
instance_id String Yes DCS instance ID
|
||||
backup_id String Yes ID of the backup record
|
||||
=========== ====== ========= =======================
|
||||
|
||||
Example
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{dcs_endpoint}/v1.0/885cacf2d49d4bb6931ae668e9c07553/instances/e016385d-b9fa-4bf0-9f38-9379f4a5293f/backups/75509c85-50a6-4525-ad56-a1bb62e84570
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
None.
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
|
||||
|
||||
Response
|
||||
--------
|
||||
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
|
||||
@ -42,7 +42,7 @@ Request
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
@ -110,6 +110,8 @@ Response
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>`. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| is_support_restore | String | An indicator of whether restoration is supported. Options: **TRUE** or **FALSE**. |
|
||||
@ -157,6 +159,7 @@ Response
|
||||
"updated_at": "2019-05-10T08:32:30.546Z",
|
||||
"execution_at": "2019-05-10T08:31:21.461Z",
|
||||
"backup_type": "manual",
|
||||
"backup_format": "AOF",
|
||||
"backup_name": "backup_20190510163116",
|
||||
"error_code": null,
|
||||
"is_support_restore": "TRUE"
|
||||
@ -42,7 +42,7 @@ Request
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
@ -98,6 +98,10 @@ Response
|
||||
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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>`. |
|
||||
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@ -118,6 +122,8 @@ Response
|
||||
"updated_at": "2017-07-18T21:41:35.182Z",
|
||||
"restore_name": "restore_20170718214120",
|
||||
"backup_name": "backup_20170718000002",
|
||||
"sourceInstanceId":"dcb96c22-fd6f-41c0-88b5-544784558dd9",
|
||||
"sourceInstanceName":"Test-DCS-MS-3-f79a983f",
|
||||
"error_code": null
|
||||
}
|
||||
],
|
||||
@ -97,8 +97,8 @@ Status Code
|
||||
|
||||
.. table:: **Table 4** Status code
|
||||
|
||||
=========== ===================================
|
||||
=========== ======================================
|
||||
Status Code Description
|
||||
=========== ===================================
|
||||
200 DCS instance restored successfully.
|
||||
=========== ===================================
|
||||
=========== ======================================
|
||||
200 Restoration task created successfully.
|
||||
=========== ======================================
|
||||
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
|
||||
@ -6,9 +6,12 @@ Distributed Cache Service - API Reference
|
||||
:maxdepth: 1
|
||||
|
||||
api_usage_guidelines
|
||||
apis_used_for_managing_dcs_instances/index
|
||||
apis_used_for_maintaining_dcs_instances/index
|
||||
apis_used_for_tenant_management/index
|
||||
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
|
||||
|
||||
@ -39,37 +39,42 @@ Request
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+=================+=================+=================+=========================================================================+
|
||||
| old_password | String | Yes | Old password. |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
|
||||
| new_password | String | Yes | New password. |
|
||||
| | | | |
|
||||
| | | | Password complexity requirements: |
|
||||
| | | | |
|
||||
| | | | - Must be a string consisting of 8 to 32 characters. |
|
||||
| | | | - Must be different from the old password. |
|
||||
| | | | - Contains at least three of the following character types: |
|
||||
| | | | |
|
||||
| | | | - Lowercase letters |
|
||||
| | | | - Uppercase letters |
|
||||
| | | | - Digits |
|
||||
| | | | - Special characters (:literal:`\`~!@#$%^&*()-_=+\\|[{}]:'",<.>/?`) |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+=================+=================+=================+====================================================================+
|
||||
| old_password | String | Yes | Old password. |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------+
|
||||
| new_password | String | Yes | New password. |
|
||||
| | | | |
|
||||
| | | | Password complexity requirements: |
|
||||
| | | | |
|
||||
| | | | - Cannot be empty. |
|
||||
| | | | - Cannot be the username or the username spelled backwards. |
|
||||
| | | | - Can be 8 to 32 characters long. |
|
||||
| | | | - Contain at least three of the following character types: |
|
||||
| | | | |
|
||||
| | | | - Lowercase letters |
|
||||
| | | | - Uppercase letters |
|
||||
| | | | - Digits |
|
||||
| | | | - Special characters (:literal:`\`~!@#$^&*()-_=+\\|{}:,<.>/?`) |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------+
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
- Request URL:
|
||||
|
||||
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password
|
||||
.. code-block:: text
|
||||
|
||||
.. code-block::
|
||||
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/password
|
||||
|
||||
{
|
||||
"old_password": "XXXXXX",
|
||||
"new_password": "XXXXXX"
|
||||
}
|
||||
- Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"old_password": "XXXXXX",
|
||||
"new_password": "XXXXXX"
|
||||
}
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -105,9 +110,9 @@ Response
|
||||
|
||||
.. code-block::
|
||||
|
||||
//Change password sucessful.
|
||||
//Change password success.
|
||||
{
|
||||
"result" : "success",
|
||||
"result" : "Success",
|
||||
"message" : "Modify DCSInstance password success.",
|
||||
"retry_times_left" : "5",
|
||||
"lock_time" : "0",
|
||||
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
@ -24,7 +24,7 @@ GET /v1.0/{project_id}/instances/statistic
|
||||
========== ====== ========= ===========
|
||||
Parameter Type Mandatory Description
|
||||
========== ====== ========= ===========
|
||||
project_id String Yes Project ID
|
||||
project_id String Yes Project ID.
|
||||
========== ====== ========= ===========
|
||||
|
||||
Request
|
||||
@ -32,7 +32,7 @@ Request
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
@ -67,7 +67,7 @@ Response
|
||||
keys Integer Number of cached data records
|
||||
instance_id String DCS instance ID
|
||||
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_set_count Integer Number of times the SET command is run
|
||||
used_cpu String Percentage of CPU usage
|
||||
@ -2,14 +2,16 @@
|
||||
|
||||
.. _dcs-api-0312018:
|
||||
|
||||
Restarting DCS Instances
|
||||
========================
|
||||
Restarting DCS Instances or Clearing DCS Instance Data
|
||||
======================================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
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
|
||||
---
|
||||
|
||||
@ -38,28 +40,36 @@ Request
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+-----------+--------+-----------+--------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+===========+========+===========+========================================================+
|
||||
| action | String | Yes | Action performed on DCS instances. Value: **restart**. |
|
||||
+-----------+--------+-----------+--------------------------------------------------------+
|
||||
| instances | Array | Yes | List of DCS instance IDs. |
|
||||
+-----------+--------+-----------+--------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+=================+=================+=================+=========================================================================+
|
||||
| action | String | Yes | Action performed on DCS instances. Options: **restart**, and **flush**. |
|
||||
| | | | |
|
||||
| | | | .. note:: |
|
||||
| | | | |
|
||||
| | | | Only DCS Redis 4.0 and 5.0 instances can be flushed. |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
|
||||
| instances | Array | Yes | List of DCS instance IDs. |
|
||||
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------+
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
- Request URL:
|
||||
|
||||
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status
|
||||
.. code-block:: text
|
||||
|
||||
.. code-block::
|
||||
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status
|
||||
|
||||
{
|
||||
"action": "restart",
|
||||
"instances": [
|
||||
"2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
|
||||
]
|
||||
}
|
||||
- Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"action": "restart",
|
||||
"instances": [
|
||||
"2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
|
||||
]
|
||||
}
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -110,8 +120,8 @@ Status Code
|
||||
|
||||
.. table:: **Table 5** Status code
|
||||
|
||||
=========== ========================================
|
||||
Status Code Description
|
||||
=========== ========================================
|
||||
200 Successfully restarted the DCS instance.
|
||||
=========== ========================================
|
||||
+-------------+-------------------------------------------------------------------+
|
||||
| Status Code | Description |
|
||||
+=============+===================================================================+
|
||||
| 200 | Successfully restarted DCS instance or cleared DCS instance data. |
|
||||
+-------------+-------------------------------------------------------------------+
|
||||
@ -77,7 +77,7 @@ Response
|
||||
|
||||
**Response parameters**
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
.. _dcs-api-0312009__table18935105020414:
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -21,19 +21,19 @@ DELETE /v1.0/{project_id}/instances/{instance_id}
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ====== ========= ===============
|
||||
=========== ====== ========= ============
|
||||
Parameter Type Mandatory Description
|
||||
=========== ====== ========= ===============
|
||||
project_id String Yes Project ID
|
||||
instance_id String Yes DCS instance ID
|
||||
=========== ====== ========= ===============
|
||||
=========== ====== ========= ============
|
||||
project_id String Yes Project ID.
|
||||
instance_id String Yes Instance ID.
|
||||
=========== ====== ========= ============
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
@ -48,11 +48,11 @@ Response
|
||||
|
||||
**Response parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example response**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
@ -2,15 +2,15 @@
|
||||
|
||||
.. _dcs-api-0312003:
|
||||
|
||||
APIs Used for Managing DCS Instances
|
||||
====================================
|
||||
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:`Deleting a Single DCS Instance <dcs-api-0312008>`
|
||||
- :ref:`Batch Deleting DCS Instances <dcs-api-0312009>`
|
||||
- :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`
|
||||
|
||||
.. toctree::
|
||||
@ -18,9 +18,9 @@ APIs Used for Managing DCS Instances
|
||||
: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
|
||||
deleting_a_single_dcs_instance
|
||||
batch_deleting_dcs_instances
|
||||
scaling_up_a_dcs_instance
|
||||
@ -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.
|
||||
|
||||
**URI**
|
||||
-------
|
||||
URI
|
||||
---
|
||||
|
||||
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 **\\"**. |
|
||||
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| instance_backup_policy | JSON | No | Backup policy. |
|
||||
| instance_backup_policy | Object | 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>`. |
|
||||
+------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 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. |
|
||||
| | | | |
|
||||
| | | | 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>`. |
|
||||
| | | | |
|
||||
@ -78,6 +78,8 @@ Request
|
||||
| security_group_id | String | No | Security group ID. |
|
||||
| | | | |
|
||||
| | | | 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**
|
||||
@ -129,11 +131,11 @@ Response
|
||||
|
||||
**Response parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example response**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
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
@ -5,14 +5,16 @@
|
||||
Other APIs
|
||||
==========
|
||||
|
||||
- :ref:`Querying AZ Information <dcs-api-0312039>`
|
||||
- :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_az_information
|
||||
querying_service_specifications
|
||||
querying_the_quota_of_a_tenant
|
||||
querying_maintenance_time_window
|
||||
querying_az_information
|
||||
|
||||
@ -20,11 +20,11 @@ Request
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -49,22 +49,27 @@ Response
|
||||
|
||||
.. table:: **Table 2** Parameter description of the available_zones array
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+==================================================================+
|
||||
| id | String | AZ ID. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------+
|
||||
| code | String | AZ code. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------+
|
||||
| name | String | AZ name. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------+
|
||||
| port | String | Port number of the AZ. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------+
|
||||
| resource_availability | String | An indicator of whether there are available resources in the AZ. |
|
||||
| | | |
|
||||
| | | - **true**: There are available resources in the AZ. |
|
||||
| | | - **false**: All resources have been used up in the AZ. |
|
||||
+-----------------------+-----------------------+------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------+------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+============================+=======================+====================================================================================+
|
||||
| id | String | AZ ID. |
|
||||
+----------------------------+-----------------------+------------------------------------------------------------------------------------+
|
||||
| code | String | AZ code. |
|
||||
+----------------------------+-----------------------+------------------------------------------------------------------------------------+
|
||||
| name | String | AZ name. |
|
||||
+----------------------------+-----------------------+------------------------------------------------------------------------------------+
|
||||
| port | String | Port number of the AZ. |
|
||||
+----------------------------+-----------------------+------------------------------------------------------------------------------------+
|
||||
| resource_availability | String | An indicator of whether there are available Redis 3.0 resources in the AZ. |
|
||||
| | | |
|
||||
| | | - **true**: There are available resources in the AZ. |
|
||||
| | | - **false**: There are no available resources 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**
|
||||
|
||||
|
||||
@ -20,11 +20,11 @@ Request
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -24,7 +24,7 @@ GET /v1.0/{project_id}/quota
|
||||
========== ====== ========= ===========
|
||||
Parameter Type Mandatory Description
|
||||
========== ====== ========= ===========
|
||||
project_id String Yes Project ID
|
||||
project_id String Yes Project ID.
|
||||
========== ====== ========= ===========
|
||||
|
||||
Request
|
||||
@ -32,11 +32,11 @@ Request
|
||||
|
||||
**Request parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example request**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -49,23 +49,23 @@ Response
|
||||
|
||||
.. table:: **Table 2** Parameter description
|
||||
|
||||
+-----------+------+-----------+-------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+===========+======+===========+===========================================================================================+
|
||||
| quotas | JSON | Yes | Quota information. For details, see :ref:`Table 3 <dcs-api-0312036__table1341618240392>`. |
|
||||
+-----------+------+-----------+-------------------------------------------------------------------------------------------+
|
||||
+-----------+--------+-----------+-------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+===========+========+===========+===========================================================================================+
|
||||
| quotas | Object | Yes | Quota information. For details, see :ref:`Table 3 <dcs-api-0312036__table1341618240392>`. |
|
||||
+-----------+--------+-----------+-------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dcs-api-0312036__table1341618240392:
|
||||
|
||||
.. table:: **Table 3** quotas parameter description
|
||||
|
||||
+---------------+-------+-----------+------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+===============+=======+===========+============================================================================================================+
|
||||
| resources | Array | Yes | List of quotas For details, see :ref:`Table 4 <dcs-api-0312036__table164180248392>`. |
|
||||
+---------------+-------+-----------+------------------------------------------------------------------------------------------------------------+
|
||||
| resource_user | JSON | Yes | Information about a resource tenant For details, see :ref:`Table 5 <dcs-api-0312036__table1641811248397>`. |
|
||||
+---------------+-------+-----------+------------------------------------------------------------------------------------------------------------+
|
||||
+---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Mandatory | Description |
|
||||
+===============+========+===========+============================================================================================================+
|
||||
| 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>`. |
|
||||
+---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _dcs-api-0312036__table164180248392:
|
||||
|
||||
@ -99,12 +99,12 @@ Response
|
||||
|
||||
.. table:: **Table 5** resource_user parameter description
|
||||
|
||||
=========== ======= ====================
|
||||
Parameter Type Description
|
||||
=========== ======= ====================
|
||||
tenant_id String Resource tenant ID
|
||||
tenant_name Integer Resource tenant name
|
||||
=========== ======= ====================
|
||||
=========== ====== ====================
|
||||
Parameter Type Description
|
||||
=========== ====== ====================
|
||||
tenant_id String Resource tenant ID
|
||||
tenant_name String Resource tenant name
|
||||
=========== ====== ====================
|
||||
|
||||
**Example response**
|
||||
|
||||
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
|
||||
@ -2,16 +2,14 @@
|
||||
|
||||
.. _dcs-api-0312017:
|
||||
|
||||
Modifying DCS Instance Configuration Parameters
|
||||
===============================================
|
||||
Modifying Configuration Parameters
|
||||
==================================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
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
|
||||
---
|
||||
|
||||
@ -63,32 +61,36 @@ For possible values of parameters in :ref:`Table 3 <dcs-api-0312017__table352152
|
||||
|
||||
**Example request**
|
||||
|
||||
.. code-block:: text
|
||||
- Request URL:
|
||||
|
||||
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
|
||||
.. code-block:: text
|
||||
|
||||
.. code-block::
|
||||
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/configs
|
||||
|
||||
{
|
||||
"redis_config": [
|
||||
{
|
||||
"param_id": "1",
|
||||
"param_name": "timeout",
|
||||
"param_value": "100"
|
||||
}
|
||||
]
|
||||
}
|
||||
- Example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"redis_config": [
|
||||
{
|
||||
"param_id": "1",
|
||||
"param_name": "timeout",
|
||||
"param_value": "100"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
**Response parameters**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
**Example response**
|
||||
|
||||
None.
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
File diff suppressed because it is too large
Load Diff
BIN
umn/source/_static/images/en-us_image_0000001148443450.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001148443450.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1004 B |
BIN
umn/source/_static/images/en-us_image_0000001148443456.png
Normal file
BIN
umn/source/_static/images/en-us_image_0000001148443456.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1004 B |
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