Compare commits
1 Commits
main
...
propose-dc
| Author | SHA1 | Date | |
|---|---|---|---|
| 700199e2af |
@ -38,6 +38,8 @@ None
|
|||||||
|
|
||||||
**Example request**
|
**Example request**
|
||||||
|
|
||||||
|
Request URL:
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
|
DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id}
|
||||||
|
|||||||
@ -52,10 +52,14 @@ Request
|
|||||||
|
|
||||||
**Example request**
|
**Example request**
|
||||||
|
|
||||||
|
Request URL:
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores
|
POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
.. code-block::
|
.. code-block::
|
||||||
|
|
||||||
{
|
{
|
||||||
|
|||||||
@ -10,10 +10,17 @@ Change History
|
|||||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Released On | What's New |
|
| Released On | What's New |
|
||||||
+===================================+====================================================================================================================================================================================================================================================================================================================================+
|
+===================================+====================================================================================================================================================================================================================================================================================================================================+
|
||||||
|
| 2022-12-13 | Modified the following content: |
|
||||||
|
| | |
|
||||||
|
| | - In section :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`, added the **include_failure** parameter and deleted the **isExactMatchName** parameter. |
|
||||||
|
| | - In section :ref:`Querying DCS Instance Status <dcs-api-0312016>`, added parameters such as **redis**, and changed the **includeFailure** parameter to **include_failure**. |
|
||||||
|
| | - Updated the example request format in section :ref:`Deleting Backup Files <dcs-api-0312024>`. |
|
||||||
|
| | - In section :ref:`Querying AZ Information <dcs-api-0312039>`, changed the **regionID** parameter to **region_id**. |
|
||||||
|
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 2022-10-12 | Modified the following content: |
|
| 2022-10-12 | Modified the following content: |
|
||||||
| | |
|
| | |
|
||||||
| | - Changed the type of the **private_ips** parameter to **Array of strings** in :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. |
|
| | - Changed the type of the **private_ips** parameter to **Array of strings** in :ref:`Scaling Up a DCS Instance <dcs-api-0312010>`. |
|
||||||
| | - Deleted the **includeFailure** parameter from :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`. |
|
| | - In section :ref:`Querying All DCS Instances of a Tenant <dcs-api-0312006>`, deleted the **includeFailure** parameter. |
|
||||||
| | - Modified the description of the **maxmemory-policy** parameter in :ref:`Parameter Management APIs <dcs-api-0312013>`. |
|
| | - Modified the description of the **maxmemory-policy** parameter in :ref:`Parameter Management APIs <dcs-api-0312013>`. |
|
||||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 2022-08-04 | Modified the following content: |
|
| 2022-08-04 | Modified the following content: |
|
||||||
@ -50,11 +57,11 @@ Change History
|
|||||||
| | |
|
| | |
|
||||||
| | - Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs. |
|
| | - Changed API categorization into lifecycle management APIs, instance management APIs, parameter management APIs, backup and restoration APIs, and other APIs. |
|
||||||
| | - Added description about creating DCS Redis 4.0 and 5.0 instances in section :ref:`Creating a DCS Instance <dcs-api-0312004>`. |
|
| | - Added description about creating DCS Redis 4.0 and 5.0 instances in section :ref:`Creating a DCS Instance <dcs-api-0312004>`. |
|
||||||
| | - Optimized :ref:`Error Codes <dcs-api-0312044>`. |
|
| | - Optimized section "Error Code." |
|
||||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 2020-06-16 | Modified the following content: |
|
| 2020-06-16 | Modified the following content: |
|
||||||
| | |
|
| | |
|
||||||
| | Added error codes such as 111400102 in section :ref:`Error Codes <dcs-api-0312044>`. |
|
| | Added error codes such as 111400102 in the **Error Codes** section. |
|
||||||
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| 2020-03-25 | Modified the following content: |
|
| 2020-03-25 | Modified the following content: |
|
||||||
| | |
|
| | |
|
||||||
|
|||||||
@ -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',
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -13,7 +13,7 @@ This API is used to query DCS instances of a tenant, and allows you to specify q
|
|||||||
URI
|
URI
|
||||||
---
|
---
|
||||||
|
|
||||||
GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&isExactMatchName={isExactMatchName}&ip={ip}&tags={key}={value}
|
GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&include_failure={include_failure}&ip={ip}&tags={key}={value}
|
||||||
|
|
||||||
:ref:`Table 1 <dcs-api-0312006__table1971216413394>` describes the parameters.
|
:ref:`Table 1 <dcs-api-0312006__table1971216413394>` describes the parameters.
|
||||||
|
|
||||||
@ -21,15 +21,15 @@ GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status=
|
|||||||
|
|
||||||
.. table:: **Table 1** Parameter description
|
.. table:: **Table 1** Parameter description
|
||||||
|
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| Parameter | Type | Mandatory | Description |
|
| Parameter | Type | Mandatory | Description |
|
||||||
+==================+==================+=================+======================================================================================================================+
|
+=================+==================+=================+=======================================================================================================================+
|
||||||
| project_id | String | Yes | Project ID. |
|
| project_id | String | Yes | Project ID. |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| start | Integer | No | Start number for querying DCS instances. It cannot be lower than 1. |
|
| start | Integer | No | Start number for querying DCS instances. It cannot be lower than 1. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | By default, the start number is 1. |
|
| | | | By default, the start number is 1. |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| limit | Integer | No | Number of DCS instances displayed on each page. |
|
| limit | Integer | No | Number of DCS instances displayed on each page. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | Minimum value: **1** |
|
| | | | Minimum value: **1** |
|
||||||
@ -37,34 +37,32 @@ GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status=
|
|||||||
| | | | Maximum value: **2000** |
|
| | | | Maximum value: **2000** |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page. |
|
| | | | If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page. |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| name | String | No | DCS instance name. |
|
| name | String | No | DCS instance name. |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| id | String | No | Instance ID. |
|
| id | String | No | Instance ID. |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| status | String | No | DCS instance status. For details about status, see :ref:`DCS Instance Statuses <dcs-api-0312047>`. |
|
| status | String | No | DCS instance status. For details about status, see :ref:`DCS Instance Statuses <dcs-api-0312047>`. |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| ip | String | No | IP address for connecting to the DCS instance |
|
| ip | String | No | IP address for connecting to the DCS instance |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| isExactMatchName | String | No | An indicator of whether to perform an exact or fuzzy match based on instance name. |
|
| include_failure | String | No | An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | Options: |
|
| | | | Options: |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | - **true**: exact match |
|
| | | | - **true**: The number of DCS instances that failed to be created will be returned to the API caller. |
|
||||||
| | | | - **false**: fuzzy match |
|
| | | | - **false** or others: The number of DCS instances that failed to be created will not be returned to the API caller. |
|
||||||
| | | | |
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
| | | | Default value: **false**. |
|
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
|
||||||
| tags | Array of Objects | No | Query based on the instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. |
|
| tags | Array of Objects | No | Query based on the instance tag key and value. *{key}* indicates the tag key, and *{value}* indicates the tag value. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | To query instances with multiple tag keys and values, separate key-value pairs with commas (,). |
|
| | | | To query instances with multiple tag keys and values, separate key-value pairs with commas (,). |
|
||||||
+------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+
|
+-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
**Example**
|
**Example**
|
||||||
|
|
||||||
.. code-block:: text
|
.. code-block:: text
|
||||||
|
|
||||||
GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&isExactMatchName=false
|
GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&include_failure=true
|
||||||
|
|
||||||
Request
|
Request
|
||||||
-------
|
-------
|
||||||
@ -95,7 +93,7 @@ Response
|
|||||||
instance_num Integer Number of DCS instances.
|
instance_num Integer Number of DCS instances.
|
||||||
============ ======= ==============================
|
============ ======= ==============================
|
||||||
|
|
||||||
.. table:: **Table 3** Parameter description of the instance array
|
.. table:: **Table 3** instances parameters
|
||||||
|
|
||||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
|
|||||||
@ -40,7 +40,7 @@ Response
|
|||||||
+-----------------+--------+---------------------------------------------------------------------------------------+
|
+-----------------+--------+---------------------------------------------------------------------------------------+
|
||||||
| Parameter | Type | Description |
|
| Parameter | Type | Description |
|
||||||
+=================+========+=======================================================================================+
|
+=================+========+=======================================================================================+
|
||||||
| regionId | String | Region ID. |
|
| region_id | String | Region ID. |
|
||||||
+-----------------+--------+---------------------------------------------------------------------------------------+
|
+-----------------+--------+---------------------------------------------------------------------------------------+
|
||||||
| available_zones | Array | Array of AZs. For details, see :ref:`Table 2 <dcs-api-0312039__table20901104905614>`. |
|
| available_zones | Array | Array of AZs. For details, see :ref:`Table 2 <dcs-api-0312039__table20901104905614>`. |
|
||||||
+-----------------+--------+---------------------------------------------------------------------------------------+
|
+-----------------+--------+---------------------------------------------------------------------------------------+
|
||||||
|
|||||||
@ -23,6 +23,6 @@ FAQs
|
|||||||
redis_commands/index
|
redis_commands/index
|
||||||
instance_scaling_and_upgrade/index
|
instance_scaling_and_upgrade/index
|
||||||
monitoring_and_alarm/index
|
monitoring_and_alarm/index
|
||||||
data_backup_export_and_migration/index
|
data_backup,_export,_and_migration/index
|
||||||
analysis_of_big_keys_and_hot_keys/index
|
analysis_of_big_keys_and_hot_keys/index
|
||||||
master_standby_switchover/index
|
master_standby_switchover/index
|
||||||
|
|||||||
@ -15,7 +15,7 @@ Instance Scaling and Upgrade
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:hidden:
|
:hidden:
|
||||||
|
|
||||||
can_dcs_redis_instances_be_upgraded_for_example_from_redis_3.0_to_redis_4.0_or_5.0
|
can_dcs_redis_instances_be_upgraded,_for_example,_from_redis_3.0_to_redis_4.0_or_5.0
|
||||||
are_services_interrupted_if_maintenance_is_performed_during_the_maintenance_time_window
|
are_services_interrupted_if_maintenance_is_performed_during_the_maintenance_time_window
|
||||||
are_instance_resources_affected_during_specification_modification
|
are_instance_resources_affected_during_specification_modification
|
||||||
are_services_interrupted_during_specification_modification
|
are_services_interrupted_during_specification_modification
|
||||||
|
|||||||
@ -21,6 +21,6 @@ Monitoring and Alarm
|
|||||||
does_redis_support_command_audits
|
does_redis_support_command_audits
|
||||||
what_should_i_do_if_the_monitoring_data_of_a_dcs_redis_instance_is_abnormal
|
what_should_i_do_if_the_monitoring_data_of_a_dcs_redis_instance_is_abnormal
|
||||||
why_is_used_memory_greater_than_available_memory
|
why_is_used_memory_greater_than_available_memory
|
||||||
why_does_bandwidth_usage_exceed_100pct
|
why_does_bandwidth_usage_exceed_100%
|
||||||
why_is_the_rejected_connections_metric_displayed
|
why_is_the_rejected_connections_metric_displayed
|
||||||
why_is_flow_control_triggered_how_do_i_handle_it
|
why_is_flow_control_triggered_how_do_i_handle_it
|
||||||
|
|||||||
@ -33,7 +33,7 @@ Redis Usage
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
:hidden:
|
:hidden:
|
||||||
|
|
||||||
why_is_cpu_usage_of_a_dcs_redis_instance_100pct
|
why_is_cpu_usage_of_a_dcs_redis_instance_100%
|
||||||
can_i_change_the_vpc_and_subnet_for_a_dcs_redis_instance
|
can_i_change_the_vpc_and_subnet_for_a_dcs_redis_instance
|
||||||
why_arent_security_groups_configured_for_dcs_redis_4.0_and_5.0_instances
|
why_arent_security_groups_configured_for_dcs_redis_4.0_and_5.0_instances
|
||||||
do_dcs_redis_instances_limit_the_size_of_a_key_or_value
|
do_dcs_redis_instances_limit_the_size_of_a_key_or_value
|
||||||
@ -44,7 +44,7 @@ Redis Usage
|
|||||||
does_dcs_for_redis_support_sentinel
|
does_dcs_for_redis_support_sentinel
|
||||||
what_is_the_default_data_eviction_policy
|
what_is_the_default_data_eviction_policy
|
||||||
what_should_i_do_if_an_error_occurs_in_redis_exporter
|
what_should_i_do_if_an_error_occurs_in_redis_exporter
|
||||||
why_is_memory_usage_more_than_100pct
|
why_is_memory_usage_more_than_100%
|
||||||
why_is_redisson_distributed_lock_not_supported_by_dcs_proxy_cluster_redis_3.0_instances
|
why_is_redisson_distributed_lock_not_supported_by_dcs_proxy_cluster_redis_3.0_instances
|
||||||
can_i_customize_or_change_the_port_for_accessing_a_dcs_instance
|
can_i_customize_or_change_the_port_for_accessing_a_dcs_instance
|
||||||
can_i_modify_the_connection_addresses_for_accessing_a_dcs_instance
|
can_i_modify_the_connection_addresses_for_accessing_a_dcs_instance
|
||||||
|
|||||||
@ -22,7 +22,7 @@ Access in Different Languages
|
|||||||
lettuce_integration_with_spring_boot
|
lettuce_integration_with_spring_boot
|
||||||
clients_in_python
|
clients_in_python
|
||||||
go-redis
|
go-redis
|
||||||
hiredis_in_c
|
hiredis_in_c++
|
||||||
csharp
|
csharp
|
||||||
php/index
|
php/index
|
||||||
node.js
|
node.js
|
||||||
|
|||||||
@ -9,7 +9,7 @@ There are two ways to access DCS:
|
|||||||
|
|
||||||
- Using the management console
|
- Using the management console
|
||||||
|
|
||||||
The DCS provides a web-based management console. To launch the DCS console, create an account on the management console and log in, and then choose **Database** > **Distributed Cache Service** on the homepage. On the DCS console, you can create, restart, and delete DCS instances, and change their passwords.
|
The DCS provides a web-based management console. To launch the DCS console, create an account on the management console and log in, and then choose **Application** > **Distributed Cache Service** on the homepage. On the DCS console, you can create, restart, and delete DCS instances, and change their passwords.
|
||||||
|
|
||||||
- Using APIs
|
- Using APIs
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user