From c4732a1b29e22f860200f3574f4955c6b9fb21dd Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Mon, 20 Feb 2023 12:24:11 +0000 Subject: [PATCH] Update content --- .../deleting_a_background_task.rst | 165 +++ .../background_task_management/index.rst | 16 + .../listing_background_tasks.rst | 288 +++++ .../backing_up_a_dcs_instance.rst | 142 +++ .../deleting_backup_files.rst | 102 ++ .../api_v2/backup_and_restoration/index.rst | 24 + .../listing_dcs_instance_backup_records.rst | 237 ++++ .../obtaining_the_backup_file_url.rst | 150 +++ ...rying_dcs_instance_restoration_records.rst | 191 +++ .../restoring_a_dcs_instance.rst | 135 +++ ...configuring_automatic_big_key_analysis.rst | 215 ++++ ...configuring_automatic_hot_key_analysis.rst | 215 ++++ .../creating_a_big_key_analysis_task.rst | 262 ++++ .../creating_a_hot_key_analysis_task.rst | 268 +++++ .../creating_an_expired_key_scan_task.rst | 242 ++++ .../deleting_a_big_key_analysis_task.rst | 174 +++ .../deleting_a_hot_key_analysis_task.rst | 174 +++ .../source/api_v2/cache_analysis/index.rst | 38 + .../listing_big_key_analysis_tasks.rst | 264 +++++ .../listing_hot_key_analysis_tasks.rst | 264 +++++ .../querying_big_key_analysis_details.rst | 272 +++++ .../querying_hot_key_analysis_details.rst | 277 +++++ ...urations_of_automatic_big_key_analysis.rst | 207 ++++ ...urations_of_automatic_hot_key_analysis.rst | 207 ++++ ...figuring_an_online_data_migration_task.rst | 270 +++++ .../creating_a_data_migration_task.rst | 321 +++++ ...creating_an_online_data_migration_task.rst | 221 ++++ .../deleting_data_migration_tasks.rst | 191 +++ .../source/api_v2/data_migration/index.rst | 32 + .../listing_migration_tasks.rst | 308 +++++ ...rying_details_of_a_data_migration_task.rst | 309 +++++ ...e_progress_of_an_online_migration_task.rst | 211 ++++ .../stopping_a_data_migration_task.rst | 309 +++++ .../stopping_data_migration_tasks.rst | 239 ++++ ...nchronization_of_a_data_migration_task.rst | 167 +++ api-ref/source/api_v2/index.rst | 38 + .../changing_the_password.rst | 161 +++ .../api_v2/instance_management/index.rst | 24 + .../master_standby_switchover.rst | 174 +++ ...modifying_the_bandwidth_of_an_instance.rst | 101 ++ ...ng_statistics_of_all_running_instances.rst | 184 +++ .../resetting_a_password.rst | 131 ++ ...nstances_or_clearing_dcs_instance_data.rst | 160 +++ .../batch_deleting_dcs_instances.rst | 160 +++ .../creating_a_dcs_instance.rst | 588 +++++++++ .../deleting_an_instance.rst | 67 ++ .../api_v2/lifecycle_management/index.rst | 26 + .../modifying_details_of_a_dcs_instance.rst | 181 +++ .../modifying_instance_specifications.rst | 134 +++ .../querying_a_dcs_instance.rst | 446 +++++++ .../querying_all_dcs_instances.rst | 432 +++++++ .../collecting_redis_run_logs.rst | 185 +++ .../source/api_v2/log_management/index.rst | 20 + .../log_management/listing_redis_run_logs.rst | 238 ++++ .../obtaining_the_log_download_link.rst | 188 +++ .../log_management/querying_the_slow_log.rst | 250 ++++ .../configuring_ip_whitelist_groups.rst | 95 +- .../{ => api_v2}/network_security/index.rst | 8 +- ...ing_the_ip_whitelist_of_a_dcs_instance.rst | 45 +- api-ref/source/api_v2/other_apis/index.rst | 24 + .../listing_maintenance_time_windows.rst | 225 ++++ ...onitored_objects_on_primary_dimensions.rst | 171 +++ ...y_dimensions_under_a_primary_dimension.rst | 239 ++++ .../source/api_v2/other_apis/querying_azs.rst | 117 ++ .../other_apis/querying_product_flavors.rst | 431 +++++++ .../other_apis/querying_the_tenant_quotas.rst | 176 +++ .../api_v2/parameter_management/index.rst | 18 + .../modifying_configuration_parameters.rst | 127 ++ ..._dcs_instance_configuration_parameters.rst | 169 +++ ...nstance_parameter_modification_records.rst | 152 +++ .../configuring_replica_priority.rst | 176 +++ .../api_v2/shards_and_replicas/index.rst | 20 + .../querying_details_of_shards.rst | 289 +++++ .../querying_instance_nodes_in_batches.rst | 302 +++++ .../removing_the_ip_address.rst | 176 +++ .../batch_adding_or_deleting_tags.rst | 104 ++ .../source/api_v2/tag_management/index.rst | 18 + .../listing_all_tags_of_a_tenant.rst | 136 +++ .../querying_tags_of_a_dcs_instance.rst | 107 ++ .../creating_a_custom_template.rst | 235 ++++ .../api_v2/template_management/index.rst | 16 + .../viewing_parameter_templates.rst | 301 +++++ api-ref/source/appendix/error_codes.rst | 1054 +++++++++-------- api-ref/source/appendix/index.rst | 4 +- .../appendix/instance_diagnosis_ids.rst | 71 ++ api-ref/source/change_history.rst | 23 +- api-ref/source/index.rst | 9 +- .../querying_dcs_instance_status.rst | 158 --- .../backing_up_a_dcs_instance.rst | 16 +- .../deleting_backup_files.rst | 14 +- .../backup_and_restoration_apis/index.rst | 0 .../querying_dcs_instance_backup_records.rst | 116 +- ...rying_dcs_instance_restoration_records.rst | 80 +- .../restoring_a_dcs_instance.rst | 20 +- .../creating_a_data_migration_task.rst | 96 +- .../data_migration_apis/index.rst | 0 api-ref/source/outdated_apis_v1/index.rst | 24 + ...hanging_the_password_of_a_dcs_instance.rst | 16 +- .../instance_management_apis/index.rst | 0 .../querying_dcs_instance_status.rst | 219 ++++ ...ng_statistics_of_all_running_instances.rst | 24 +- ...nstances_or_clearing_dcs_instance_data.rst | 16 +- .../batch_deleting_dcs_instances.rst | 28 +- .../creating_a_dcs_instance.rst | 82 +- .../deleting_a_single_dcs_instance.rst | 8 +- .../lifecycle_management_apis/index.rst | 0 ...fying_information_about_a_dcs_instance.rst | 14 +- .../querying_a_dcs_instance.rst | 44 +- ...querying_all_dcs_instances_of_a_tenant.rst | 94 +- .../scaling_up_a_dcs_instance.rst | 12 +- .../other_apis/index.rst | 0 .../other_apis/querying_az_information.rst | 24 +- .../querying_maintenance_time_window.rst | 8 +- .../querying_service_specifications.rst | 430 +++---- .../querying_the_quota_of_a_tenant.rst | 42 +- .../parameter_management_apis/index.rst | 0 .../modifying_configuration_parameters.rst | 16 +- .../querying_configuration_parameters.rst | 72 +- 118 files changed, 16320 insertions(+), 1386 deletions(-) create mode 100644 api-ref/source/api_v2/background_task_management/deleting_a_background_task.rst create mode 100644 api-ref/source/api_v2/background_task_management/index.rst create mode 100644 api-ref/source/api_v2/background_task_management/listing_background_tasks.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/backing_up_a_dcs_instance.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/deleting_backup_files.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/index.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/listing_dcs_instance_backup_records.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/obtaining_the_backup_file_url.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/querying_dcs_instance_restoration_records.rst create mode 100644 api-ref/source/api_v2/backup_and_restoration/restoring_a_dcs_instance.rst create mode 100644 api-ref/source/api_v2/cache_analysis/configuring_automatic_big_key_analysis.rst create mode 100644 api-ref/source/api_v2/cache_analysis/configuring_automatic_hot_key_analysis.rst create mode 100644 api-ref/source/api_v2/cache_analysis/creating_a_big_key_analysis_task.rst create mode 100644 api-ref/source/api_v2/cache_analysis/creating_a_hot_key_analysis_task.rst create mode 100644 api-ref/source/api_v2/cache_analysis/creating_an_expired_key_scan_task.rst create mode 100644 api-ref/source/api_v2/cache_analysis/deleting_a_big_key_analysis_task.rst create mode 100644 api-ref/source/api_v2/cache_analysis/deleting_a_hot_key_analysis_task.rst create mode 100644 api-ref/source/api_v2/cache_analysis/index.rst create mode 100644 api-ref/source/api_v2/cache_analysis/listing_big_key_analysis_tasks.rst create mode 100644 api-ref/source/api_v2/cache_analysis/listing_hot_key_analysis_tasks.rst create mode 100644 api-ref/source/api_v2/cache_analysis/querying_big_key_analysis_details.rst create mode 100644 api-ref/source/api_v2/cache_analysis/querying_hot_key_analysis_details.rst create mode 100644 api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_big_key_analysis.rst create mode 100644 api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_hot_key_analysis.rst create mode 100644 api-ref/source/api_v2/data_migration/configuring_an_online_data_migration_task.rst create mode 100644 api-ref/source/api_v2/data_migration/creating_a_data_migration_task.rst create mode 100644 api-ref/source/api_v2/data_migration/creating_an_online_data_migration_task.rst create mode 100644 api-ref/source/api_v2/data_migration/deleting_data_migration_tasks.rst create mode 100644 api-ref/source/api_v2/data_migration/index.rst create mode 100644 api-ref/source/api_v2/data_migration/listing_migration_tasks.rst create mode 100644 api-ref/source/api_v2/data_migration/querying_details_of_a_data_migration_task.rst create mode 100644 api-ref/source/api_v2/data_migration/querying_the_progress_of_an_online_migration_task.rst create mode 100644 api-ref/source/api_v2/data_migration/stopping_a_data_migration_task.rst create mode 100644 api-ref/source/api_v2/data_migration/stopping_data_migration_tasks.rst create mode 100644 api-ref/source/api_v2/data_migration/stopping_synchronization_of_a_data_migration_task.rst create mode 100644 api-ref/source/api_v2/index.rst create mode 100644 api-ref/source/api_v2/instance_management/changing_the_password.rst create mode 100644 api-ref/source/api_v2/instance_management/index.rst create mode 100644 api-ref/source/api_v2/instance_management/master_standby_switchover.rst create mode 100644 api-ref/source/api_v2/instance_management/modifying_the_bandwidth_of_an_instance.rst create mode 100644 api-ref/source/api_v2/instance_management/querying_statistics_of_all_running_instances.rst create mode 100644 api-ref/source/api_v2/instance_management/resetting_a_password.rst create mode 100644 api-ref/source/api_v2/instance_management/restarting_dcs_instances_or_clearing_dcs_instance_data.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/batch_deleting_dcs_instances.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/creating_a_dcs_instance.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/deleting_an_instance.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/index.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/modifying_details_of_a_dcs_instance.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/modifying_instance_specifications.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/querying_a_dcs_instance.rst create mode 100644 api-ref/source/api_v2/lifecycle_management/querying_all_dcs_instances.rst create mode 100644 api-ref/source/api_v2/log_management/collecting_redis_run_logs.rst create mode 100644 api-ref/source/api_v2/log_management/index.rst create mode 100644 api-ref/source/api_v2/log_management/listing_redis_run_logs.rst create mode 100644 api-ref/source/api_v2/log_management/obtaining_the_log_download_link.rst create mode 100644 api-ref/source/api_v2/log_management/querying_the_slow_log.rst rename api-ref/source/{ => api_v2}/network_security/configuring_ip_whitelist_groups.rst (71%) rename api-ref/source/{ => api_v2}/network_security/index.rst (59%) rename api-ref/source/{ => api_v2}/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst (66%) create mode 100644 api-ref/source/api_v2/other_apis/index.rst create mode 100644 api-ref/source/api_v2/other_apis/listing_maintenance_time_windows.rst create mode 100644 api-ref/source/api_v2/other_apis/listing_monitored_objects_on_primary_dimensions.rst create mode 100644 api-ref/source/api_v2/other_apis/listing_monitored_objects_on_secondary_dimensions_under_a_primary_dimension.rst create mode 100644 api-ref/source/api_v2/other_apis/querying_azs.rst create mode 100644 api-ref/source/api_v2/other_apis/querying_product_flavors.rst create mode 100644 api-ref/source/api_v2/other_apis/querying_the_tenant_quotas.rst create mode 100644 api-ref/source/api_v2/parameter_management/index.rst create mode 100644 api-ref/source/api_v2/parameter_management/modifying_configuration_parameters.rst create mode 100644 api-ref/source/api_v2/parameter_management/querying_dcs_instance_configuration_parameters.rst create mode 100644 api-ref/source/api_v2/parameter_management/querying_the_list_of_instance_parameter_modification_records.rst create mode 100644 api-ref/source/api_v2/shards_and_replicas/configuring_replica_priority.rst create mode 100644 api-ref/source/api_v2/shards_and_replicas/index.rst create mode 100644 api-ref/source/api_v2/shards_and_replicas/querying_details_of_shards.rst create mode 100644 api-ref/source/api_v2/shards_and_replicas/querying_instance_nodes_in_batches.rst create mode 100644 api-ref/source/api_v2/shards_and_replicas/removing_the_ip_address.rst create mode 100644 api-ref/source/api_v2/tag_management/batch_adding_or_deleting_tags.rst create mode 100644 api-ref/source/api_v2/tag_management/index.rst create mode 100644 api-ref/source/api_v2/tag_management/listing_all_tags_of_a_tenant.rst create mode 100644 api-ref/source/api_v2/tag_management/querying_tags_of_a_dcs_instance.rst create mode 100644 api-ref/source/api_v2/template_management/creating_a_custom_template.rst create mode 100644 api-ref/source/api_v2/template_management/index.rst create mode 100644 api-ref/source/api_v2/template_management/viewing_parameter_templates.rst create mode 100644 api-ref/source/appendix/instance_diagnosis_ids.rst delete mode 100644 api-ref/source/instance_management_apis/querying_dcs_instance_status.rst rename api-ref/source/{ => outdated_apis_v1}/backup_and_restoration_apis/backing_up_a_dcs_instance.rst (71%) rename api-ref/source/{ => outdated_apis_v1}/backup_and_restoration_apis/deleting_backup_files.rst (71%) rename api-ref/source/{ => outdated_apis_v1}/backup_and_restoration_apis/index.rst (100%) rename api-ref/source/{ => outdated_apis_v1}/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst (87%) rename api-ref/source/{ => outdated_apis_v1}/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst (87%) rename api-ref/source/{ => outdated_apis_v1}/backup_and_restoration_apis/restoring_a_dcs_instance.rst (72%) rename api-ref/source/{ => outdated_apis_v1}/data_migration_apis/creating_a_data_migration_task.rst (66%) rename api-ref/source/{ => outdated_apis_v1}/data_migration_apis/index.rst (100%) create mode 100644 api-ref/source/outdated_apis_v1/index.rst rename api-ref/source/{ => outdated_apis_v1}/instance_management_apis/changing_the_password_of_a_dcs_instance.rst (90%) rename api-ref/source/{ => outdated_apis_v1}/instance_management_apis/index.rst (100%) create mode 100644 api-ref/source/outdated_apis_v1/instance_management_apis/querying_dcs_instance_status.rst rename api-ref/source/{ => outdated_apis_v1}/instance_management_apis/querying_statistics_of_all_running_instances.rst (82%) rename api-ref/source/{ => outdated_apis_v1}/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst (84%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/batch_deleting_dcs_instances.rst (87%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/creating_a_dcs_instance.rst (96%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/deleting_a_single_dcs_instance.rst (72%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/index.rst (100%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst (95%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/querying_a_dcs_instance.rst (96%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst (86%) rename api-ref/source/{ => outdated_apis_v1}/lifecycle_management_apis/scaling_up_a_dcs_instance.rst (86%) rename api-ref/source/{ => outdated_apis_v1}/other_apis/index.rst (100%) rename api-ref/source/{ => outdated_apis_v1}/other_apis/querying_az_information.rst (81%) rename api-ref/source/{ => outdated_apis_v1}/other_apis/querying_maintenance_time_window.rst (88%) rename api-ref/source/{ => outdated_apis_v1}/other_apis/querying_service_specifications.rst (69%) rename api-ref/source/{ => outdated_apis_v1}/other_apis/querying_the_quota_of_a_tenant.rst (82%) rename api-ref/source/{ => outdated_apis_v1}/parameter_management_apis/index.rst (100%) rename api-ref/source/{ => outdated_apis_v1}/parameter_management_apis/modifying_configuration_parameters.rst (76%) rename api-ref/source/{ => outdated_apis_v1}/parameter_management_apis/querying_configuration_parameters.rst (98%) diff --git a/api-ref/source/api_v2/background_task_management/deleting_a_background_task.rst b/api-ref/source/api_v2/background_task_management/deleting_a_background_task.rst new file mode 100644 index 0000000..d40f1ad --- /dev/null +++ b/api-ref/source/api_v2/background_task_management/deleting_a_background_task.rst @@ -0,0 +1,165 @@ +:original_name: DeleteBackgroundTask_0.html + +.. _DeleteBackgroundTask_0: + +Deleting a Background Task +========================== + +Function +-------- + +This API is used to delete a background task. + +URI +--- + +DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== =================== + Parameter Mandatory Type Description + =========== ========= ====== =================== + project_id Yes String Project ID. + instance_id Yes String Instance ID. + task_id Yes String Background task ID. + =========== ========= ====== =================== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +204 Background task deleted successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/background_task_management/index.rst b/api-ref/source/api_v2/background_task_management/index.rst new file mode 100644 index 0000000..84f0ae8 --- /dev/null +++ b/api-ref/source/api_v2/background_task_management/index.rst @@ -0,0 +1,16 @@ +:original_name: BackgroudTasksManagement_0.html + +.. _BackgroudTasksManagement_0: + +Background Task Management +========================== + +- :ref:`Listing Background Tasks ` +- :ref:`Deleting a Background Task ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + listing_background_tasks + deleting_a_background_task diff --git a/api-ref/source/api_v2/background_task_management/listing_background_tasks.rst b/api-ref/source/api_v2/background_task_management/listing_background_tasks.rst new file mode 100644 index 0000000..b8d8cba --- /dev/null +++ b/api-ref/source/api_v2/background_task_management/listing_background_tasks.rst @@ -0,0 +1,288 @@ +:original_name: ListBackgroundTask_0.html + +.. _ListBackgroundTask_0: + +Listing Background Tasks +======================== + +Function +-------- + +This API is used to list background tasks. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/tasks + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+=========+=====================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | start_time | No | String | Query start time (UTC). Format: yyyyMMddHHmmss, for example, **20200609160000**. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | end_time | No | String | Query end time (UTC). Format: yyyyMMddHHmmss, for example, **20200617155959**. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------+----------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + | Parameter | Type | Description | + +============+====================================================================================================+==========================================================+ + | updated_at | String | Task end time, in the format 2020-06-17T07:38:42.503Z. | + +------------+----------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + | created_at | String | Task start time, in the format 2020-06-17T07:38:42.503Z. | + +------------+----------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + | status | String | Task status. | + +------------+----------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + | task_count | String | Number of tasks. | + +------------+----------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + | tasks | Array of :ref:`SingleBackgroundTask ` objects | Task details array. | + +------------+----------------------------------------------------------------------------------------------------+----------------------------------------------------------+ + +.. _listbackgroundtask_0__response_singlebackgroundtask: + +.. table:: **Table 4** SingleBackgroundTask + + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========================================================================+==========================================================+ + | id | String | Background task ID. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | name | String | Background task name. The options are as follows: | + | | | | + | | | **ChangeInstanceSpec**: modifying specifications | + | | | | + | | | **BindEip**: enabling public access | + | | | | + | | | **UnBindEip**: disabling public access | + | | | | + | | | **AddReplica**: adding replicas | + | | | | + | | | **DelReplica**: deleting replicas | + | | | | + | | | **AddWhitelist**: configuring an IP whitelist | + | | | | + | | | **UpdatePort**: changing the port | + | | | | + | | | **RemoveIpFromDns**: removing IP addresses | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | details | :ref:`DetailsBody ` object | Details. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | user_name | String | Username. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | user_id | String | User ID. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | params | String | Task parameters. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | status | String | Task status. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | created_at | String | Task start time, in the format 2020-06-17T07:38:42.503Z. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | updated_at | String | Task end time, in the format 2020-06-17T07:38:42.503Z. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + | enable_show | Boolean | Task details that can be expanded. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------+ + +.. _listbackgroundtask_0__response_detailsbody: + +.. table:: **Table 5** DetailsBody + + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+=========+=============================================================================================================+ + | old_capacity | String | Capacity before the modification. This parameter has a value only when the specifications are modified. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | new_capacity | String | Capacity after the modification. This parameter has a value only when the specifications are modified. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | enable_public_ip | Boolean | Whether public access is enabled. This parameter has a value only when public access is enabled. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | public_ip_id | String | ID of the IP address used for public access. This parameter has a value only when public access is enabled. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | IP address used for public access. This parameter has a value only when public access is enabled. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | enable_ssl | Boolean | Whether SSL is enabled. This parameter has a value only when SSL is enabled. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | old_cache_mode | String | Cache type before the modification. This parameter has a value only when the specifications are modified. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + | new_cache_mode | String | Cache type after the modification. This parameter has a value only when the specifications are modified. | + +-------------------+---------+-------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks?offset=0&limit=10&begin_time=20200609160000&end_time=20200617155959 + +Example Responses +----------------- + +**Status code: 200** + +Background tasks listed successfully. + +.. code-block:: + + { + "task_count" : 1, + "tasks" : [ { + "id" : "8abf6e1e72c12e7c0172c15b508500aa", + "name" : "ChangeInstanceSpec", + "user_name" : "paas_dcs_a00421997_02", + "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", + "details" : { + "old_cache_mode" : "single", + "new_cache_mode" : "single", + "old_capacity" : 0.125, + "new_capacity" : 0.25 + }, + "enable_show" : false, + "status" : "SUCCESS", + "created_at" : "2020-06-17T08:18:06.597Z", + "updated_at" : "2020-06-17T08:18:10.106Z" + } ] + } + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +200 Background tasks listed successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/backup_and_restoration/backing_up_a_dcs_instance.rst b/api-ref/source/api_v2/backup_and_restoration/backing_up_a_dcs_instance.rst new file mode 100644 index 0000000..96a773c --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/backing_up_a_dcs_instance.rst @@ -0,0 +1,142 @@ +:original_name: CopyInstance_0.html + +.. _CopyInstance_0: + +Backing Up a DCS Instance +========================= + +Function +-------- + +This API is used to back up a specific DCS instance. + +.. note:: + + Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/backups + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-----------------+-----------------+-----------------+-------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================+ + | remark | No | String | Description of DCS instance backup. | + +-----------------+-----------------+-----------------+-------------------------------------+ + | backup_format | No | String | Format of the DCS instance backup. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **aof** | + | | | | | + | | | | - **rdb** | + +-----------------+-----------------+-----------------+-------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + backup_id String Backup ID. + ========= ====== =========== + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups + + { + "remark" : "Backup instances", + "backup_format" : "aof" + } + +Example Responses +----------------- + +**Status code: 200** + +The specified DCS instance is backed up successfully. + +.. code-block:: + + { + "backup_id" : "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7" + } + +Status Codes +------------ + +=========== ===================================================== +Status Code Description +=========== ===================================================== +200 The specified DCS instance is backed up successfully. +400 Invalid request. +500 Internal service error. +=========== ===================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/backup_and_restoration/deleting_backup_files.rst b/api-ref/source/api_v2/backup_and_restoration/deleting_backup_files.rst new file mode 100644 index 0000000..5aa9d0c --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/deleting_backup_files.rst @@ -0,0 +1,102 @@ +:original_name: DeleteBackupFile_0.html + +.. _DeleteBackupFile_0: + +Deleting Backup Files +===================== + +Function +-------- + +This API is used to delete the backup files of a DCS instance. + +URI +--- + +DELETE /v2/{project_id}/instances/{instance_id}/backups/{backup_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + backup_id Yes String Backup ID. + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups/{backup_id} + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ================================= +Status Code Description +=========== ================================= +204 Backup file deleted successfully. +400 Invalid request. +500 Internal service error. +=========== ================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/backup_and_restoration/index.rst b/api-ref/source/api_v2/backup_and_restoration/index.rst new file mode 100644 index 0000000..0de18b2 --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/index.rst @@ -0,0 +1,24 @@ +:original_name: BackupRestoreManagement_0.html + +.. _BackupRestoreManagement_0: + +Backup and Restoration +====================== + +- :ref:`Deleting Backup Files ` +- :ref:`Restoring a DCS Instance ` +- :ref:`Querying DCS Instance Restoration Records ` +- :ref:`Obtaining the Backup File URL ` +- :ref:`Backing Up a DCS Instance ` +- :ref:`Listing DCS Instance Backup Records ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + deleting_backup_files + restoring_a_dcs_instance + querying_dcs_instance_restoration_records + obtaining_the_backup_file_url + backing_up_a_dcs_instance + listing_dcs_instance_backup_records diff --git a/api-ref/source/api_v2/backup_and_restoration/listing_dcs_instance_backup_records.rst b/api-ref/source/api_v2/backup_and_restoration/listing_dcs_instance_backup_records.rst new file mode 100644 index 0000000..2c60a46 --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/listing_dcs_instance_backup_records.rst @@ -0,0 +1,237 @@ +:original_name: ListBackupRecords_0.html + +.. _ListBackupRecords_0: + +Listing DCS Instance Backup Records +=================================== + +Function +-------- + +This API is used to query the backup records of a specific DCS instance. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/backups + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+=========+=====================================================================================================+ + | begin_time | No | String | Query start time (UTC). Format: yyyyMMddHHmmss, for example, 20170718235959. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | end_time | No | String | Query end time (UTC). Format: yyyyMMddHHmmss, for example, 20170718235959. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------------------+---------------------------------------------------------------------------------------------------+------------------------------+ + | Parameter | Type | Description | + +========================+===================================================================================================+==============================+ + | total_num | Integer | Number of returned records. | + +------------------------+---------------------------------------------------------------------------------------------------+------------------------------+ + | backup_record_response | Array of :ref:`BackupRecordResponse ` objects | Array of the backup details. | + +------------------------+---------------------------------------------------------------------------------------------------+------------------------------+ + +.. _listbackuprecords_0__response_backuprecordresponse: + +.. table:: **Table 4** BackupRecordResponse + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================================+ + | backup_id | String | Backup ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | period | String | Backup execution time. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | backup_name | String | Backup record name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | size | Long | Size of the backup file (byte). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | backup_type | String | Backup type. | + | | | | + | | | - **manual**: manual backup | + | | | | + | | | - **auto**: automatic backup | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the backup task is created. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | updated_at | String | Time at which DCS instance backup is completed. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | progress | String | Backup progress. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | error_code | String | Error code displayed for a backup failure. | + | | | | + | | | - *dcs.08.0001* - Failed to start the backup and restoration tool. | + | | | | + | | | - *dcs.08.0002* - Execution timed out. | + | | | | + | | | - *dcs.08.0003* - Failed to delete the bucket. | + | | | | + | | | - *dcs.08.0004* - Failed to obtain the AK/SK. | + | | | | + | | | - *dcs.08.0005* - Failed to create the bucket. | + | | | | + | | | - *dcs.08.0006* - Failed to query the backup data size. | + | | | | + | | | - *dcs.08.0007* - Failed to synchronize data during restoration. | + | | | | + | | | - *dcs.08.0008* - The scheduled backup task is not running. The instance is running other tasks. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | remark | String | Description of DCS instance backup. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | status | String | Backup status. The options are as follows: | + | | | | + | | | - **waiting**: The task is waiting to begin. | + | | | | + | | | - **backuping**: DCS instance backup is in progress. | + | | | | + | | | - **succeed**: DCS instance backup succeeded. | + | | | | + | | | - **failed**: DCS instance backup failed. | + | | | | + | | | - **expired**: The backup file has expired. | + | | | | + | | | - **deleted**: The backup file has been deleted manually. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **backuping** | + | | | | + | | | - **succeed** | + | | | | + | | | - **failed** | + | | | | + | | | - **expired** | + | | | | + | | | - **deleted** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | is_support_restore | String | Whether restoration is supported. Options: **TRUE** and **FALSE**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups?offset={offset}&limit={limit}&beginTime={begin_Time}&end_time={end_Time} + +Example Responses +----------------- + +**Status code: 200** + +DCS instance backup records queried successfully. + +.. code-block:: + + { + "total_num" : 1, + "backup_record_response" : [ { + "period" : { }, + "backup_type" : "manual", + "created_at" : "2019-05-10T08:31:16.166Z", + "remark" : "001", + "is_support_restore" : "TRUE", + "backup_id" : "4631832a-14c6-45b0-a0b3-3abd8f591ad1", + "backup_name" : "backup_20190510163116", + "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", + "size" : 880232, + "updated_at" : "2019-05-10T08:32:30.546Z", + "progress" : "100.00", + "error_code" : { }, + "status" : "succeed" + } ] + } + +Status Codes +------------ + +=========== ================================================= +Status Code Description +=========== ================================================= +200 DCS instance backup records queried successfully. +204 No DCS instance backup record is found. +400 Invalid request. +500 Internal service error. +=========== ================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/backup_and_restoration/obtaining_the_backup_file_url.rst b/api-ref/source/api_v2/backup_and_restoration/obtaining_the_backup_file_url.rst new file mode 100644 index 0000000..df883c8 --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/obtaining_the_backup_file_url.rst @@ -0,0 +1,150 @@ +:original_name: ListBackupFileLinks_0.html + +.. _ListBackupFileLinks_0: + +Obtaining the Backup File URL +============================= + +Function +-------- + +This API is used to obtain the download links of backup files. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/backups/{backup_id}/links + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + backup_id Yes String Backup ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +------------+-----------+---------+---------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+=========+=======================================================================================+ + | expiration | Yes | Integer | Validity period (in seconds) of a URL. The value range is from 5 minutes to 24 hours. | + +------------+-----------+---------+---------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+===============================================================================+=====================================================================================+ + | file_path | String | Paths of files in the OBS bucket. | + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | bucket_name | String | Name of the OBS bucket. | + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + | links | Array of :ref:`LinksItem ` objects | Collection of URLs for downloading backup files. A maximum of 64 links are allowed. | + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ + +.. _listbackupfilelinks_0__response_linksitem: + +.. table:: **Table 4** LinksItem + + ========= ====== ================================= + Parameter Type Description + ========= ====== ================================= + file_name String Backup file name. + link String URL for downloading backup files. + ========= ====== ================================= + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/backups/{backup_id}/links + + { + "expiration" : 1800 + } + +Example Responses +----------------- + +**Status code: 200** + +Successfully obtained backup file URLs. + +.. code-block:: + + { + "file_path" : "42489641-23c4-4855-bc89-befc85e2b7f7/ddfe5f66-a965-43ff-aec7-f3b489dc071b/", + "bucket_name" : "bucket5da9cf3bfabc4cae9023695b934e5e2b", + "links" : [ { + "file_name" : "redis_192.168.63.250_6379_10923-16383_20190820211816.rdb", + "link" : "https://bucket5da9cf3bfabc4cae9023695b934e5e2b.{obs_endpoint}:443/42489641-23c4-4855-bc89-befc85e2b7f7/ddfe5f66-a965-43ff-aec7-f3b489dc071b/redis_192.168.63.250_6379_10923-16383_20190820211816.rdb?AWSAccessKeyId=VD8CEQNG8VMQODUAAM0D&Expires=1566308915&Signature=s3I%2BrLbo%2BFZw%2BUsjVere%2FOQdKEg%3D" + } ] + } + +Status Codes +------------ + +=========== ======================================= +Status Code Description +=========== ======================================= +200 Successfully obtained backup file URLs. +400 Invalid request. +500 Internal service error. +=========== ======================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/backup_and_restoration/querying_dcs_instance_restoration_records.rst b/api-ref/source/api_v2/backup_and_restoration/querying_dcs_instance_restoration_records.rst new file mode 100644 index 0000000..f25a72f --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/querying_dcs_instance_restoration_records.rst @@ -0,0 +1,191 @@ +:original_name: ListRestoreRecords_0.html + +.. _ListRestoreRecords_0: + +Querying DCS Instance Restoration Records +========================================= + +Function +-------- + +This API is used to query the restoration records of a specific DCS instance. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/restores + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+=========+=====================================================================================================+ + | begin_time | No | String | Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | end_time | No | String | End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +------------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------+ + | Parameter | Type | Description | + +=========================+==================================================================================================+===================================+ + | restore_record_response | Array of :ref:`InstanceRestoreInfo ` objects | Array of the restoration records. | + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------+ + | total_num | Integer | Total number. | + +-------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------+ + +.. _listrestorerecords_0__response_instancerestoreinfo: + +.. table:: **Table 4** InstanceRestoreInfo + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================================+ + | backup_id | String | Backup ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | restore_id | String | ID of the restoration record. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | backup_name | String | Backup record name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the restoration completed. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | restore_remark | String | Description of the restoration. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the restoration task was created. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | progress | String | Restoration progress. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | error_code | String | Error code displayed for a restoration failure. | + | | | | + | | | - *dcs.08.0001* - Failed to start the backup and restoration tool. | + | | | | + | | | - *dcs.08.0002* - Execution timed out. | + | | | | + | | | - *dcs.08.0003* - Failed to delete the bucket. | + | | | | + | | | - *dcs.08.0004* - Failed to obtain the AK/SK. | + | | | | + | | | - *dcs.08.0005* - Failed to create the bucket. | + | | | | + | | | - *dcs.08.0006* - Failed to query the backup data size. | + | | | | + | | | - *dcs.08.0007* - Failed to synchronize data during restoration. | + | | | | + | | | - *dcs.08.0008* - The scheduled backup task is not running. The instance is running other tasks. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | restore_name | String | Name of a restoration record. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | backup_remark | String | Description of the backup. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + | status | String | Restoration status. | + | | | | + | | | - **waiting**: The task is waiting to begin. | + | | | | + | | | - **restoring**: The restoration is in progress. | + | | | | + | | | - **succeed**: The restoration is successful. | + | | | | + | | | - **failed**: The restoration failed. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **restoring** | + | | | | + | | | - **succeed** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/restores?offset={offset}&limit={limit}&begin_Time={begin_Time}&end_Time={end_Time} + +Example Responses +----------------- + +**Status code: 200** + +DCS instance restoration records queried successfully. + +.. code-block:: + + { + "restore_record_response" : [ { + "backup_id" : "f4823e9e-fe9b-4ffd-be79-4e5d6de272bb", + "restore_id" : "a6155972-800c-4170-a479-3231e907d2f6", + "backup_name" : "backup_20170718000002", + "updated_at" : "2017-07-18T21:41:35.182Z", + "restore_remark" : "doctest", + "created_at" : "2017-07-18T21:41:20.721Z", + "progress" : "100.00", + "error_code" : { }, + "restore_name" : "restore_20170718214120", + "backup_remark" : { }, + "status" : "succeed" + } ], + "total_num" : 1 + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 DCS instance restoration records queried successfully. +400 Invalid request. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/backup_and_restoration/restoring_a_dcs_instance.rst b/api-ref/source/api_v2/backup_and_restoration/restoring_a_dcs_instance.rst new file mode 100644 index 0000000..6ae72f2 --- /dev/null +++ b/api-ref/source/api_v2/backup_and_restoration/restoring_a_dcs_instance.rst @@ -0,0 +1,135 @@ +:original_name: RestoreInstance_0.html + +.. _RestoreInstance_0: + +Restoring a DCS Instance +======================== + +Function +-------- + +This API is used to restore the backup data to a specific DCS instance. + +.. note:: + + Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/restores + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + ========= ========= ====== ======================================== + Parameter Mandatory Type Description + ========= ========= ====== ======================================== + backup_id Yes String Backup ID. + remark No String Description of DCS instance restoration. + ========= ========= ====== ======================================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========== ====== ============================= + Parameter Type Description + ========== ====== ============================= + restore_id String ID of the restoration record. + ========== ====== ============================= + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/restores + + { + "backup_id" : "8ba256cb-e5ac-44f6-a3da-c03d8f0e5029", + "remark" : "restore instance" + } + +Example Responses +----------------- + +**Status code: 200** + +Instance restored successfully. + +.. code-block:: + + { + "restore_id" : "a6155972-800c-4170-a479-3231e907d2f6" + } + +Status Codes +------------ + +=========== =============================== +Status Code Description +=========== =============================== +200 Instance restored successfully. +400 Invalid request. +500 Internal service error. +=========== =============================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/configuring_automatic_big_key_analysis.rst b/api-ref/source/api_v2/cache_analysis/configuring_automatic_big_key_analysis.rst new file mode 100644 index 0000000..3b6be70 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/configuring_automatic_big_key_analysis.rst @@ -0,0 +1,215 @@ +:original_name: UpdateBigkeyAutoscanConfig_0.html + +.. _UpdateBigkeyAutoscanConfig_0: + +Configuring Automatic Big Key Analysis +====================================== + +Function +-------- + +This API is used to configure automatic big key analysis. + +URI +--- + +PUT /v2/{project_id}/instances/{instance_id}/bigkey/autoscan + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +------------------+-----------+------------------+-------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+==================+===============================================================================+ + | enable_auto_scan | No | Boolean | Whether to enable scheduled cache analysis. | + +------------------+-----------+------------------+-------------------------------------------------------------------------------+ + | schedule_at | No | Array of strings | UTC time of the day that cache analysis is scheduled for. Example: **21:00**. | + +------------------+-----------+------------------+-------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------------+------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+==================+======================================================================================+ + | instance_id | String | Instance ID. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | enable_auto_scan | Boolean | Whether to enable scheduled cache analysis. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | schedule_at | Array of strings | UTC time of the day that analysis is scheduled for. Example: **21:00**. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | updated_at | String | Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey/autoscan + + { + "enable_auto_scan" : true, + "schedule_at" : [ "21:00" ] + } + +Example Responses +----------------- + +**Status code: 200** + +Big key analysis task configured successfully. + +.. code-block:: + + { + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "enable_auto_scan" : true, + "schedule_at" : [ "21:00" ], + "updated_at" : "2020-06-17T02:42:40.793Z" + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4919", + "error_msg" : "Does not support bigkey analyze." + } + +Status Codes +------------ + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Big key analysis task configured successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/configuring_automatic_hot_key_analysis.rst b/api-ref/source/api_v2/cache_analysis/configuring_automatic_hot_key_analysis.rst new file mode 100644 index 0000000..144eb25 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/configuring_automatic_hot_key_analysis.rst @@ -0,0 +1,215 @@ +:original_name: UpdateHotkeyAutoScanConfig_0.html + +.. _UpdateHotkeyAutoScanConfig_0: + +Configuring Automatic Hot Key Analysis +====================================== + +Function +-------- + +This API is used to configure automatic hot key analysis. + +URI +--- + +PUT /v2/{project_id}/instances/{instance_id}/hotkey/autoscan + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +------------------+-----------+------------------+-------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+==================+===============================================================================+ + | enable_auto_scan | No | Boolean | Whether to enable scheduled cache analysis. | + +------------------+-----------+------------------+-------------------------------------------------------------------------------+ + | schedule_at | No | Array of strings | UTC time of the day that cache analysis is scheduled for. Example: **21:00**. | + +------------------+-----------+------------------+-------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------------+------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+==================+======================================================================================+ + | instance_id | String | Instance ID. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | enable_auto_scan | Boolean | Whether to enable scheduled cache analysis. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | schedule_at | Array of strings | UTC time of the day that analysis is scheduled for. Example: **21:00**. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | updated_at | String | Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey/autoscan + + { + "enable_auto_scan" : true, + "schedule_at" : [ "21:00" ] + } + +Example Responses +----------------- + +**Status code: 200** + +Automatic hot key analysis configured successfully. + +.. code-block:: + + { + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "enable_auto_scan" : true, + "schedule_at" : [ "21:00" ], + "updated_at" : "2020-06-17T02:42:40.793Z" + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4922", + "error_msg" : "Does not support hotkey analyze." + } + +Status Codes +------------ + +=========== =================================================== +Status Code Description +=========== =================================================== +200 Automatic hot key analysis configured successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== =================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/creating_a_big_key_analysis_task.rst b/api-ref/source/api_v2/cache_analysis/creating_a_big_key_analysis_task.rst new file mode 100644 index 0000000..07b9def --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/creating_a_big_key_analysis_task.rst @@ -0,0 +1,262 @@ +:original_name: CreateBigkeyScanTask_0.html + +.. _CreateBigkeyScanTask_0: + +Creating a Big Key Analysis Task +================================ + +Function +-------- + +This API is used to create a big key analysis task for a DCS Redis instance. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/bigkey-task + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+================================================================================================================================================================+ + | id | String | Big key analysis record ID. | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Analysis task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Analysis mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when an analysis task started. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when an analysis task ended. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | num | Integer | Number of big keys. | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | keys | Array of :ref:`BigkeysBody ` objects | Big key record. (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createbigkeyscantask_0__response_bigkeysbody: + +.. table:: **Table 3** BigkeysBody + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================================+ + | name | String | Key name. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Key type. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **string** | + | | | | + | | | - **list** | + | | | | + | | | - **set** | + | | | | + | | | - **zset** | + | | | | + | | | - **hash** | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | shard | String | Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is **ip:port**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | db | Integer | Database where the big key is located. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | size | Long | Size of the key value. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | unit | String | Unit of the key size. When the key type is string, the unit is byte. When the key type is list, set, zset, or hash, the unit is count. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task + +Example Responses +----------------- + +**Status code: 200** + +Big key analysis task created successfully. + +.. code-block:: + + { + "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "status" : "waiting", + "scan_type" : "manual", + "created_at" : "2020-06-15T02:21:18.669Z", + "num" : 0 + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4919", + "error_msg" : "Does not support bigkey analyze." + } + +Status Codes +------------ + +=========== =========================================== +Status Code Description +=========== =========================================== +200 Big key analysis task created successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== =========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/creating_a_hot_key_analysis_task.rst b/api-ref/source/api_v2/cache_analysis/creating_a_hot_key_analysis_task.rst new file mode 100644 index 0000000..87da96c --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/creating_a_hot_key_analysis_task.rst @@ -0,0 +1,268 @@ +:original_name: CreateHotkeyScanTask_0.html + +.. _CreateHotkeyScanTask_0: + +Creating a Hot Key Analysis Task +================================ + +Function +-------- + +This API is used to create a hot key analysis task. Redis 3.0 does not support hot key analysis. + +To perform hot key analysis, the instance's **maxmemory-policy** parameter must be set to **allkeys-lfu** or **volatile-lfu**. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/hotkey-task + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+================================================================================================================================================================+ + | id | String | Hot key analysis record ID. | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Analysis task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Analysis mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when an analysis task started. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when an analysis task ended. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | num | Integer | Number of hot keys. | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | keys | Array of :ref:`HotkeysBody ` objects | Hot key record. (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createhotkeyscantask_0__response_hotkeysbody: + +.. table:: **Table 3** HotkeysBody + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==================================================================================================================================================================================================================================================================================================================================+ + | name | String | Key name. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Key type. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **string** | + | | | | + | | | - **list** | + | | | | + | | | - **set** | + | | | | + | | | - **zset** | + | | | | + | | | - **hash** | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard | String | Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is **ip:port**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db | Integer | Database where the hot key is located. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Long | Size of the key value. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | unit | String | Unit of the key size. When the key type is string, the unit is byte. When the key type is list, set, zset, or hash, the unit is count. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | freq | Integer | Access frequency of a key within a specific period of time. | + | | | | + | | | The value is the logarithmic access frequency counter. The maximum value is 255, which indicates 1 million access requests. After the frequency reaches 255, the value will no longer increase even if access requests continue to increase. The value will decrease by 1 for every minute during which the key is not accessed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task + +Example Responses +----------------- + +**Status code: 200** + +Hot key analysis task created successfully. + +.. code-block:: + + { + "id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a", + "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", + "status" : "waiting", + "scan_type" : "manual", + "created_at" : "2020-06-15T02:21:18.669Z", + "num" : 0 + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4922", + "error_msg" : "Does not support hotkey analyze." + } + +Status Codes +------------ + +=========== =========================================== +Status Code Description +=========== =========================================== +200 Hot key analysis task created successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== =========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/creating_an_expired_key_scan_task.rst b/api-ref/source/api_v2/cache_analysis/creating_an_expired_key_scan_task.rst new file mode 100644 index 0000000..12f9350 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/creating_an_expired_key_scan_task.rst @@ -0,0 +1,242 @@ +:original_name: CreateAutoExpireScanTask.html + +.. _CreateAutoExpireScanTask: + +Creating an Expired Key Scan Task +================================= + +Function +-------- + +This API is used to create an expired key scan task. Redis 3.0 does not support expired key scan. The keyspace will be scanned to release the memory used by expired keys that were not released due to the lazy free mechanism. This scan is on the master node of the instance and will affect instance performance. Perform this operation during off-peak hours. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/scan-expire-keys-task + +.. table:: **Table 1** Path Parameters + + +-----------------+-----------------+-----------------+-----------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=================+ + | project_id | Yes | String | Project ID. | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **36** | + +-----------------+-----------------+-----------------+-----------------+ + | instance_id | Yes | String | Instance ID. | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **36** | + +-----------------+-----------------+-----------------+-----------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================================================================================================================+ + | id | String | Expired key scan ID. | + | | | | + | | | Minimum: **0** | + | | | | + | | | Maximum: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + | | | | + | | | Minimum: **0** | + | | | | + | | | Maximum: **36** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Scan task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Scan mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when a scan task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when a scan task started. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the scan task is being created.) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when a scan task ended. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the scan task is being created.) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/scan-expire-keys-task + +Example Responses +----------------- + +**Status code: 200** + +Expired key scan task created successfully. + +.. code-block:: + + { + "id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a", + "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79", + "status" : "waiting", + "scan_type" : "manual", + "created_at" : "2020-06-15T02:21:18.669Z" + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4818", + "error_msg" : "Do not support auto expire scan." + } + +Status Codes +------------ + +=========== =========================================== +Status Code Description +=========== =========================================== +200 Expired key scan task created successfully. +400 Invalid request. +401 Invalid authentication information. +403 Request rejected. +404 The requested resource could not be found. +500 Internal service error. +=========== =========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/deleting_a_big_key_analysis_task.rst b/api-ref/source/api_v2/cache_analysis/deleting_a_big_key_analysis_task.rst new file mode 100644 index 0000000..4d18219 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/deleting_a_big_key_analysis_task.rst @@ -0,0 +1,174 @@ +:original_name: DeleteBigkeyScanTask_0.html + +.. _DeleteBigkeyScanTask_0: + +Deleting a Big Key Analysis Task +================================ + +Function +-------- + +This API is used to delete a big key analysis task. + +URI +--- + +DELETE /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ================================ + Parameter Mandatory Type Description + =========== ========= ====== ================================ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + bigkey_id Yes String ID of the big key analysis task. + =========== ========= ====== ================================ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task/858ee14c-2271-4489-8b82-7bda7459ae3e + +Example Responses +----------------- + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4919", + "error_msg" : "Does not support bigkey analyze." + } + +Status Codes +------------ + +=========== =========================================== +Status Code Description +=========== =========================================== +204 Big key analysis task deleted successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== =========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/deleting_a_hot_key_analysis_task.rst b/api-ref/source/api_v2/cache_analysis/deleting_a_hot_key_analysis_task.rst new file mode 100644 index 0000000..2852a92 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/deleting_a_hot_key_analysis_task.rst @@ -0,0 +1,174 @@ +:original_name: DeleteHotkeyScanTask_0.html + +.. _DeleteHotkeyScanTask_0: + +Deleting a Hot Key Analysis Task +================================ + +Function +-------- + +This API is used to delete a hot key analysis task. + +URI +--- + +DELETE /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ================================ + Parameter Mandatory Type Description + =========== ========= ====== ================================ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + hotkey_id Yes String ID of the hot key analysis task. + =========== ========= ====== ================================ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task/0ccb25d5-27cf-4188-b5ea-987730a85371 + +Example Responses +----------------- + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4922", + "error_msg" : "Does not support hotkey analyze." + } + +Status Codes +------------ + +=========== ============================================= +Status Code Description +=========== ============================================= +204 Hot key analysis record deleted successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ============================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/index.rst b/api-ref/source/api_v2/cache_analysis/index.rst new file mode 100644 index 0000000..6e1578c --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/index.rst @@ -0,0 +1,38 @@ +:original_name: CacheAnalysisManagement_0.html + +.. _CacheAnalysisManagement_0: + +Cache Analysis +============== + +- :ref:`Creating a Big Key Analysis Task ` +- :ref:`Listing Big Key Analysis Tasks ` +- :ref:`Querying Big Key Analysis Details ` +- :ref:`Deleting a Big Key Analysis Task ` +- :ref:`Configuring Automatic Big Key Analysis ` +- :ref:`Querying the Configurations of Automatic Big Key Analysis ` +- :ref:`Creating a Hot Key Analysis Task ` +- :ref:`Listing Hot Key Analysis Tasks ` +- :ref:`Querying Hot Key Analysis Details ` +- :ref:`Deleting a Hot Key Analysis Task ` +- :ref:`Configuring Automatic Hot Key Analysis ` +- :ref:`Querying the Configurations of Automatic Hot Key Analysis ` +- :ref:`Creating an Expired Key Scan Task ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_big_key_analysis_task + listing_big_key_analysis_tasks + querying_big_key_analysis_details + deleting_a_big_key_analysis_task + configuring_automatic_big_key_analysis + querying_the_configurations_of_automatic_big_key_analysis + creating_a_hot_key_analysis_task + listing_hot_key_analysis_tasks + querying_hot_key_analysis_details + deleting_a_hot_key_analysis_task + configuring_automatic_hot_key_analysis + querying_the_configurations_of_automatic_hot_key_analysis + creating_an_expired_key_scan_task diff --git a/api-ref/source/api_v2/cache_analysis/listing_big_key_analysis_tasks.rst b/api-ref/source/api_v2/cache_analysis/listing_big_key_analysis_tasks.rst new file mode 100644 index 0000000..1652842 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/listing_big_key_analysis_tasks.rst @@ -0,0 +1,264 @@ +:original_name: ListBigkeyScanTasks_0.html + +.. _ListBigkeyScanTasks_0: + +Listing Big Key Analysis Tasks +============================== + +Function +-------- + +This API is used to query the list of big key analysis tasks. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/bigkey-tasks + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | status | No | String | Analysis task status. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **waiting** | + | | | | | + | | | | - **running** | + | | | | | + | | | | - **success** | + | | | | | + | | | | - **failed** | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + | Parameter | Type | Description | + +=============+===========================================================================================+==================================+ + | instance_id | String | Instance ID. | + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + | count | Integer | Total. | + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + | records | Array of :ref:`RecordsResponse ` objects | List of big key analysis record. | + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + +.. _listbigkeyscantasks_0__response_recordsresponse: + +.. table:: **Table 4** RecordsResponse + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================================================================+ + | id | String | Task execution record ID. (This ID corresponds to the task ID in the parameter for querying big key or hot key analysis details.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Analysis task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Analysis mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when an analysis task started. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when an analysis task ended. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-tasks + +Example Responses +----------------- + +**Status code: 200** + +Big key analysis records queried successfully. + +.. code-block:: + + { + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "count" : 1, + "records" : [ { + "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", + "scan_type" : "manual", + "status" : "success", + "created_at" : "2020-06-15T02:21:18.669Z", + "started_at" : "2020-06-15T02:21:23.534Z", + "finished_at" : "2020-06-15T02:21:25.588Z" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4919", + "error_msg" : "Does not support bigkey analyze." + } + +Status Codes +------------ + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Big key analysis records queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/listing_hot_key_analysis_tasks.rst b/api-ref/source/api_v2/cache_analysis/listing_hot_key_analysis_tasks.rst new file mode 100644 index 0000000..dd42187 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/listing_hot_key_analysis_tasks.rst @@ -0,0 +1,264 @@ +:original_name: ListHotKeyScanTasks_0.html + +.. _ListHotKeyScanTasks_0: + +Listing Hot Key Analysis Tasks +============================== + +Function +-------- + +This API is used to query the list of hot key analysis tasks. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/hotkey-tasks + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | status | No | String | Analysis task status. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **waiting** | + | | | | | + | | | | - **running** | + | | | | | + | | | | - **success** | + | | | | | + | | | | - **failed** | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + | Parameter | Type | Description | + +=============+===========================================================================================+==================================+ + | instance_id | String | Instance ID. | + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + | count | Integer | Total. | + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + | records | Array of :ref:`RecordsResponse ` objects | List of hot key analysis record. | + +-------------+-------------------------------------------------------------------------------------------+----------------------------------+ + +.. _listhotkeyscantasks_0__response_recordsresponse: + +.. table:: **Table 4** RecordsResponse + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================================================================+ + | id | String | Task execution record ID. (This ID corresponds to the task ID in the parameter for querying big key or hot key analysis details.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Analysis task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Analysis mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when an analysis task started. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when an analysis task ended. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-tasks + +Example Responses +----------------- + +**Status code: 200** + +Hot key analysis tasks listed successfully. + +.. code-block:: + + { + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "count" : 1, + "records" : [ { + "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", + "scan_type" : "manual", + "status" : "success", + "created_at" : "2020-06-15T02:21:18.669Z", + "started_at" : "2020-06-15T02:21:23.534Z", + "finished_at" : "2020-06-15T02:21:25.588Z" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4922", + "error_msg" : "Does not support hotkey analyze." + } + +Status Codes +------------ + +=========== =========================================== +Status Code Description +=========== =========================================== +200 Hot key analysis tasks listed successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== =========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/querying_big_key_analysis_details.rst b/api-ref/source/api_v2/cache_analysis/querying_big_key_analysis_details.rst new file mode 100644 index 0000000..7b2f3bc --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/querying_big_key_analysis_details.rst @@ -0,0 +1,272 @@ +:original_name: ShowBigkeyScanTaskDetails_0.html + +.. _ShowBigkeyScanTaskDetails_0: + +Querying Big Key Analysis Details +================================= + +Function +-------- + +This API is used to query the big key analysis details. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ================================ + Parameter Mandatory Type Description + =========== ========= ====== ================================ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + bigkey_id Yes String ID of the big key analysis task. + =========== ========= ====== ================================ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=========================================================================================+================================================================================================================================================================+ + | id | String | Big key analysis record ID. | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Analysis task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Analysis mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when an analysis task started. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when an analysis task ended. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | num | Integer | Number of big keys. | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | keys | Array of :ref:`BigkeysBody ` objects | Big key record. (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showbigkeyscantaskdetails_0__response_bigkeysbody: + +.. table:: **Table 3** BigkeysBody + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================================+ + | name | String | Key name. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Key type. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **string** | + | | | | + | | | - **list** | + | | | | + | | | - **set** | + | | | | + | | | - **zset** | + | | | | + | | | - **hash** | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | shard | String | Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is **ip:port**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | db | Integer | Database where the big key is located. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | size | Long | Size of the key value. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | unit | String | Unit of the key size. When the key type is string, the unit is byte. When the key type is list, set, zset, or hash, the unit is count. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task/858ee14c-2271-4489-8b82-7bda7459ae3e + +Example Responses +----------------- + +**Status code: 200** + +Big key analysis details queried successfully. + +.. code-block:: + + { + "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "status" : "success", + "scan_type" : "manual", + "created_at" : "2020-06-15T02:21:18.669Z", + "started_at" : "2020-06-15T02:21:23.534Z", + "finished_at" : "2020-06-15T02:21:25.588Z", + "keys" : [ { + "name" : "dcs-bigkey-test", + "type" : "string", + "shard" : "192.168.1.134:6379", + "db" : 0, + "size" : 3000, + "unit" : "byte" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4919", + "error_msg" : "Does not support bigkey analyze." + } + +Status Codes +------------ + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Big key analysis details queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/querying_hot_key_analysis_details.rst b/api-ref/source/api_v2/cache_analysis/querying_hot_key_analysis_details.rst new file mode 100644 index 0000000..c0ebb6a --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/querying_hot_key_analysis_details.rst @@ -0,0 +1,277 @@ +:original_name: ShowHotkeyTaskDetails_0.html + +.. _ShowHotkeyTaskDetails_0: + +Querying Hot Key Analysis Details +================================= + +Function +-------- + +This API is used to query the hot key analysis details. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ================================ + Parameter Mandatory Type Description + =========== ========= ====== ================================ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + hotkey_id Yes String ID of the hot key analysis task. + =========== ========= ====== ================================ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================+================================================================================================================================================================+ + | id | String | Hot key analysis record ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Analysis task status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **waiting** | + | | | | + | | | - **running** | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scan_type | String | Analysis mode. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **manual** | + | | | | + | | | - **auto** | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when an analysis task is created. The format is "2020-06-15T02:21:18.669Z". | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_at | String | Time when an analysis task started. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_at | String | Time when an analysis task ended. The format is "2020-06-15T02:21:18.669Z". (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | num | Integer | Number of hot keys. | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | keys | Array of :ref:`HotkeysBody ` objects | Hot key record. (The value is null and is not returned when the analysis task is being created.) | + +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showhotkeytaskdetails_0__response_hotkeysbody: + +.. table:: **Table 3** HotkeysBody + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==================================================================================================================================================================================================================================================================================================================================+ + | name | String | Key name. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | String | Key type. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **string** | + | | | | + | | | - **list** | + | | | | + | | | - **set** | + | | | | + | | | - **zset** | + | | | | + | | | - **hash** | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shard | String | Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is **ip:port**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db | Integer | Database where the hot key is located. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Long | Size of the key value. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | unit | String | Unit of the key size. When the key type is string, the unit is byte. When the key type is list, set, zset, or hash, the unit is count. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | freq | Integer | Access frequency of a key within a specific period of time. | + | | | | + | | | The value is the logarithmic access frequency counter. The maximum value is 255, which indicates 1 million access requests. After the frequency reaches 255, the value will no longer increase even if access requests continue to increase. The value will decrease by 1 for every minute during which the key is not accessed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task/0ccb25d5-27cf-4188-b5ea-987730a85371 + +Example Responses +----------------- + +**Status code: 200** + +Hot key analysis details queried successfully. + +.. code-block:: + + { + "id" : "858ee14c-2271-4489-8b82-7bda7459ae3e", + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "status" : "success", + "scan_type" : "manual", + "created_at" : "2020-06-15T02:21:18.669Z", + "started_at" : "2020-06-15T02:21:23.534Z", + "finished_at" : "2020-06-15T02:21:25.588Z", + "keys" : [ { + "name" : "dcs-hotkey-test", + "type" : "string", + "shard" : "192.168.1.134:6379", + "db" : 0, + "size" : 3000, + "unit" : "byte", + "freq" : 4 + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4922", + "error_msg" : "Does not support hotkey analyze." + } + +Status Codes +------------ + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Hot key analysis details queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_big_key_analysis.rst b/api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_big_key_analysis.rst new file mode 100644 index 0000000..32b54b5 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_big_key_analysis.rst @@ -0,0 +1,207 @@ +:original_name: ShowBigkeyAutoscanConfig_0.html + +.. _ShowBigkeyAutoscanConfig_0: + +Querying the Configurations of Automatic Big Key Analysis +========================================================= + +Function +-------- + +This API is used to query configurations of automatic big key analysis. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/bigkey/autoscan + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +------------------+------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+==================+======================================================================================+ + | instance_id | String | Instance ID. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | enable_auto_scan | Boolean | Whether to enable scheduled cache analysis. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | schedule_at | Array of strings | UTC time of the day that analysis is scheduled for. Example: **21:00**. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | updated_at | String | Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey/autoscan + +Example Responses +----------------- + +**Status code: 200** + +This API is used to query configurations of automatic big key analysis. + +.. code-block:: + + { + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "enable_auto_scan" : true, + "schedule_at" : [ "21:00" ], + "updated_at" : "2020-06-17T02:42:40.793Z" + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4919", + "error_msg" : "Does not support bigkey analyze." + } + +Status Codes +------------ + ++-------------+-------------------------------------------------------------------------+ +| Status Code | Description | ++=============+=========================================================================+ +| 200 | This API is used to query configurations of automatic big key analysis. | ++-------------+-------------------------------------------------------------------------+ +| 400 | Invalid request. | ++-------------+-------------------------------------------------------------------------+ +| 401 | Invalid authentication information. | ++-------------+-------------------------------------------------------------------------+ +| 403 | The request is rejected. | ++-------------+-------------------------------------------------------------------------+ +| 404 | The requested resource is not found. | ++-------------+-------------------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+-------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_hot_key_analysis.rst b/api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_hot_key_analysis.rst new file mode 100644 index 0000000..cc7fbb6 --- /dev/null +++ b/api-ref/source/api_v2/cache_analysis/querying_the_configurations_of_automatic_hot_key_analysis.rst @@ -0,0 +1,207 @@ +:original_name: ShowHotkeyAutoscanConfig_0.html + +.. _ShowHotkeyAutoscanConfig_0: + +Querying the Configurations of Automatic Hot Key Analysis +========================================================= + +Function +-------- + +This API is used to query configurations of automatic hot key analysis. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/hotkey/autoscan + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +------------------+------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+==================+======================================================================================+ + | instance_id | String | Instance ID. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | enable_auto_scan | Boolean | Whether to enable scheduled cache analysis. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | schedule_at | Array of strings | UTC time of the day that analysis is scheduled for. Example: **21:00**. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + | updated_at | String | Time when the configuration is updated. The time format is 2020-06-15T02:21:18.669Z. | + +------------------+------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey/autoscan + +Example Responses +----------------- + +**Status code: 200** + +This API is used to query configurations of automatic hot key analysis. + +.. code-block:: + + { + "instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3", + "enable_auto_scan" : true, + "schedule_at" : [ "21:00" ], + "updated_at" : "2020-06-17T02:42:40.793Z" + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4922", + "error_msg" : "Does not support hotkey analyze." + } + +Status Codes +------------ + ++-------------+-------------------------------------------------------------------------+ +| Status Code | Description | ++=============+=========================================================================+ +| 200 | This API is used to query configurations of automatic hot key analysis. | ++-------------+-------------------------------------------------------------------------+ +| 400 | Invalid request. | ++-------------+-------------------------------------------------------------------------+ +| 401 | Invalid authentication information. | ++-------------+-------------------------------------------------------------------------+ +| 403 | The request is rejected. | ++-------------+-------------------------------------------------------------------------+ +| 404 | The requested resource is not found. | ++-------------+-------------------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+-------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/configuring_an_online_data_migration_task.rst b/api-ref/source/api_v2/data_migration/configuring_an_online_data_migration_task.rst new file mode 100644 index 0000000..cee807c --- /dev/null +++ b/api-ref/source/api_v2/data_migration/configuring_an_online_data_migration_task.rst @@ -0,0 +1,270 @@ +:original_name: SetOnlineMigrationTask_0.html + +.. _SetOnlineMigrationTask_0: + +Configuring an Online Data Migration Task +========================================= + +Function +-------- + +This API is used to configure an online data migration task. + +URI +--- + +POST /v2/{project_id}/migration/{task_id}/task + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== ========================= + Parameter Mandatory Type Description + ========== ========= ====== ========================= + project_id Yes String Project ID. + task_id Yes String Online migration task ID. + ========== ========= ====== ========================= + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +--------------------+-----------------+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +====================+=================+===========================================================================================================+======================================================================================================================================================================================================================================================================================================================================================================+ + | migration_method | Yes | String | Type of the migration, which can be full migration or incremental migration. | + | | | | | + | | | | - Full migration: Suitable for scenarios where services can be interrupted. Data is migrated at one time. Source instance data updated during full migration will not be migrated to the target instance. | + | | | | | + | | | | - Incremental migration: Suitable for scenarios requiring minimal service downtime. The incremental migration parses logs to ensure data consistency between the source and target instances. Value options are as follows: | + | | | | | + | | | | - **full_amount_migration**: full migration | + | | | | | + | | | | - **incremental_migration**: incremental migration | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **full_amount_migration** | + | | | | | + | | | | - **incremental_migration** | + +--------------------+-----------------+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resume_mode | Yes | String | Reconnection mode. In automatic reconnection mode, if the source and target instances are disconnected due to network exceptions, automatic reconnections will be performed indefinitely. Full synchronization will be triggered and requires more bandwidth if incremental synchronization becomes unavailable. Exercise caution when enabling this option. Values: | + | | | | | + | | | | - **auto**: automatically reconnect. | + | | | | | + | | | | - **manual**: manually reconnect. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **auto** | + | | | | | + | | | | - **manual** | + +--------------------+-----------------+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_limit_mb | No | String | "Bandwidth limit. For incremental migration, you can limit the bandwidth to ensure smooth service running. When the data synchronization speed reaches the limit, it can no longer increase. | + | | | | | + | | | | - Unit: MB/s | + | | | | | + | | | | - Value range: an integer from 1 to 10,241 | + +--------------------+-----------------+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_instance | Yes | :ref:`ConfigMigrationInstanceBody ` object | Source Redis information. | + +--------------------+-----------------+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance | Yes | :ref:`ConfigMigrationInstanceBody ` object | Target Redis information. | + +--------------------+-----------------+-----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _setonlinemigrationtask_0__request_configmigrationinstancebody: + +.. table:: **Table 3** ConfigMigrationInstanceBody + + +-----------+-----------+--------+------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+========================================================================+ + | id | No | String | Redis instance ID. (If **addrs** is not set, **id** must be set.) | + +-----------+-----------+--------+------------------------------------------------------------------------+ + | addrs | No | String | Redis instance address. (If **id** is not set, **addrs** must be set.) | + +-----------+-----------+--------+------------------------------------------------------------------------+ + | password | No | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+-----------+--------+------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================+ + | id | String | Migration task ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | name | String | Migration task name. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | status | String | Migration task status. The value can be **SUCCESS**, **FAILED**, **MIGRATING**, or **TERMINATED**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **SUCCESS** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **MIGRATING** | + | | | | + | | | - **TERMINATED** | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/migration/{task_id}/task + + { + "migration_method" : "incremental_migration", + "bandwidth_limit_mb" : 123, + "resume_mode" : "auto", + "source_instance" : { + "id" : null, + "addrs" : "192.168.1.1:6379,192.168.0.0:6379", + "password" : "xxxxxx" + }, + "target_instance" : { + "id" : "cf4a05df-1c38-47c5-bb5a-0a7b3673b3bd", + "addrs" : null, + "password" : null + } + } + +Example Responses +----------------- + +**Status code: 200** + +Online data migration task configured. + +.. code-block:: + + { + "id" : "90754308-a156-406f-a837-8f852f38a646", + "name" : "dcs-migration-1db7", + "status" : "FULLMIGRATING" + } + +Status Codes +------------ + +=========== ====================================== +Status Code Description +=========== ====================================== +200 Online data migration task configured. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ====================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/creating_a_data_migration_task.rst b/api-ref/source/api_v2/data_migration/creating_a_data_migration_task.rst new file mode 100644 index 0000000..f0e930a --- /dev/null +++ b/api-ref/source/api_v2/data_migration/creating_a_data_migration_task.rst @@ -0,0 +1,321 @@ +:original_name: CreateMigrationTask_0.html + +.. _CreateMigrationTask_0: + +Creating a Data Migration Task +============================== + +Function +-------- + +This API is used to create a data migration task. + +URI +--- + +POST /v2/{project_id}/migration-task + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+=================+======================================================================================+==============================================================================================================================================================+ + | task_name | Yes | String | Migration task name. | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Migration task description. | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_type | Yes | String | Mode of the migration. Values: | + | | | | | + | | | | - **backupfile_import**: importing backup files | + | | | | | + | | | | - **online_migration**: migrating data online | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **backupfile_import** | + | | | | | + | | | | - **online_migration** | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_method | Yes | String | Type of the migration, which can be full migration or incremental migration. Values: | + | | | | | + | | | | - **full_amount_migration**: full migration | + | | | | | + | | | | - **incremental_migration**: incremental migration | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **full_amount_migration** | + | | | | | + | | | | - **incremental_migration** | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_files | No | :ref:`BackupFilesBody ` object | Backup files to be imported when the migration mode is backup file import. | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_type | No | String | Type of the network for communication between the source and target Redis when the migration mode is online data migration. The network type can VPC or VPN. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **vpc** | + | | | | | + | | | | - **vpn** | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_instance | No | :ref:`SourceInstanceBody ` object | Source Redis information. This parameter is mandatory when the migration mode is online data migration. | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance | Yes | :ref:`TargetInstanceBody ` object | Target Redis information. | + +------------------+-----------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createmigrationtask_0__request_backupfilesbody: + +.. table:: **Table 3** BackupFilesBody + + +-----------------+-----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+======================================================================+=========================================================================================================+ + | file_source | No | String | Data source, which can be an OBS bucket or a backup record. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **self_build_obs** | + | | | | | + | | | | - **backup_record** | + +-----------------+-----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | bucket_name | Yes | String | Name of the OBS bucket. | + +-----------------+-----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | files | Yes | Array of :ref:`Files ` objects | List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket. | + +-----------------+-----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | backup_id | No | String | Backup record ID. This parameter is mandatory when the data source is a backup record. | + +-----------------+-----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + +.. _createmigrationtask_0__request_files: + +.. table:: **Table 4** Files + + +-----------+-----------+--------+--------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+==========================================================================+ + | file_name | Yes | String | Name of a backup file. | + +-----------+-----------+--------+--------------------------------------------------------------------------+ + | size | No | String | File size in bytes. | + +-----------+-----------+--------+--------------------------------------------------------------------------+ + | update_at | No | String | Time when the file was last modified. The format is YYYY-MM-DD HH:MM:SS. | + +-----------+-----------+--------+--------------------------------------------------------------------------+ + +.. _createmigrationtask_0__request_sourceinstancebody: + +.. table:: **Table 5** SourceInstanceBody + + +-----------+-----------+--------+---------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+=====================================================================+ + | addrs | Yes | String | Source Redis name (specified in the **source_instance** parameter). | + +-----------+-----------+--------+---------------------------------------------------------------------+ + | password | No | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+-----------+--------+---------------------------------------------------------------------+ + +.. _createmigrationtask_0__request_targetinstancebody: + +.. table:: **Table 6** TargetInstanceBody + + +-----------+-----------+--------+-----------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+=======================================================================+ + | id | Yes | String | Redis instance ID (mandatory in the **target_instance** parameter). | + +-----------+-----------+--------+-----------------------------------------------------------------------+ + | name | No | String | Redis instance name (specified in the **target_instance** parameter). | + +-----------+-----------+--------+-----------------------------------------------------------------------+ + | password | No | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+-----------+--------+-----------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================+ + | id | String | Migration task ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | name | String | Migration task name. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | status | String | Migration task status. The value can be **SUCCESS**, **FAILED**, **MIGRATING**, or **TERMINATED**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **SUCCESS** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **MIGRATING** | + | | | | + | | | - **TERMINATED** | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 11** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 12** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/migration-task + + { + "task_name" : "migration1", + "description" : "Test", + "migration_type" : "online_migration", + "migration_method" : "full_amount_migration", + "network_type" : "vpc", + "source_instance" : { + "addrs" : "192.168.1.135:6379", + "password" : "xxxxxx" + }, + "target_instance" : { + "name" : "dcs-test", + "id" : "4cd5dbb8-aacd-4603-b817-3e97d48c7a20" + } + } + +Example Responses +----------------- + +**Status code: 200** + +Data migration task created successfully. + +.. code-block:: + + { + "id" : "8aa6999e71cb638b0171f485f5266ef0", + "name" : "dcs-test", + "status" : "MIGRATING" + } + +Status Codes +------------ + +=========== ========================================= +Status Code Description +=========== ========================================= +200 Data migration task created successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ========================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/creating_an_online_data_migration_task.rst b/api-ref/source/api_v2/data_migration/creating_an_online_data_migration_task.rst new file mode 100644 index 0000000..6016359 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/creating_an_online_data_migration_task.rst @@ -0,0 +1,221 @@ +:original_name: CreateOnlineMigrationTask_0.html + +.. _CreateOnlineMigrationTask_0: + +Creating an Online Data Migration Task +====================================== + +Function +-------- + +This API is used to create an online data migration task. + +URI +--- + +POST /v2/{project_id}/migration/instance + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===================+=================+=================+=================================================================================================================================================================================================================================================================================================================+ + | name | Yes | String | Name of the online migration task. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description of the online migration task. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | VPC ID. | + | | | | | + | | | | You can obtain it in either of the following ways: | + | | | | | + | | | | - Method 1: Log in to the VPC console and view the VPC ID in the VPC details. | + | | | | | + | | | | - Method 2: Call the VPC API. For details, see . | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | Yes | String | Subnet network ID. | + | | | | | + | | | | You can obtain it in either of the following ways: | + | | | | | + | | | | - Method 1: Log in to VPC console and click the target subnet on the **Subnets** tab page. You can view the network ID on the displayed page. | + | | | | | + | | | | - Method 2: Call the VPC API. For details, see . | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | Yes | String | ID of the security group to which the instance belongs. A security group implements access control for VMs within a security group or in different security groups, enhancing VM security. You can define different access rules for a security group to protect the VMs that are added to this security group. | + | | | | | + | | | | You can obtain it in either of the following ways: | + | | | | | + | | | | - Method 1: Log in to the VPC console and choose **Access Control** > **Security Groups**. You can create and configure a security group, and obtain the security group ID. | + | | | | | + | | | | - Method 2: Call the API used to query security group details. For details, see . | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + =========== ====== ========================= + Parameter Type Description + =========== ====== ========================= + instance_id String Online migration task ID. + =========== ====== ========================= + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/migration/instance + + { + "name" : "dcs-migration-thrc", + "description" : "Creating an online data migration task", + "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", + "subnet_id" : "40f15ed6-7f85-49d5-ba0e-65b940d4812c", + "security_group_id" : "9df96622-24b7-4813-84b8-ab74552a21d7" + } + +Example Responses +----------------- + +**Status code: 200** + +Online data migration task created. + +.. code-block:: + + { + "instance_id" : "b21989ec-2889-4b8e-99db-19c073425ec2" + } + +Status Codes +------------ + +=========== ==================================== +Status Code Description +=========== ==================================== +200 Online data migration task created. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ==================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/deleting_data_migration_tasks.rst b/api-ref/source/api_v2/data_migration/deleting_data_migration_tasks.rst new file mode 100644 index 0000000..2cd4958 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/deleting_data_migration_tasks.rst @@ -0,0 +1,191 @@ +:original_name: DeleteMigrationTask_0.html + +.. _DeleteMigrationTask_0: + +Deleting Data Migration Tasks +============================= + +Function +-------- + +This API is used to delete data migration tasks. + +URI +--- + +DELETE /v2/{project_id}/migration-tasks/delete + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +--------------+-----------+------------------+---------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+==================+===================================================+ + | task_id_list | Yes | Array of strings | List of IDs of the migration tasks to be deleted. | + +--------------+-----------+------------------+---------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +--------------+------------------+---------------------------------------------------+ + | Parameter | Type | Description | + +==============+==================+===================================================+ + | task_id_list | Array of strings | List of IDs of the migration tasks to be deleted. | + +--------------+------------------+---------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks/delete + + { + "task_id_list" : [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ] + } + +Example Responses +----------------- + +**Status code: 200** + +Data migration task deleted successfully. + +.. code-block:: + + { + "task_id_list" : [ "2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca" ] + } + +Status Codes +------------ + +=========== ========================================= +Status Code Description +=========== ========================================= +200 Data migration task deleted successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ========================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/index.rst b/api-ref/source/api_v2/data_migration/index.rst new file mode 100644 index 0000000..bcce6b6 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/index.rst @@ -0,0 +1,32 @@ +:original_name: DataMigrationManagement_0.html + +.. _DataMigrationManagement_0: + +Data Migration +============== + +- :ref:`Creating a Data Migration Task ` +- :ref:`Listing Migration Tasks ` +- :ref:`Deleting Data Migration Tasks ` +- :ref:`Querying Details of a Data Migration Task ` +- :ref:`Stopping a Data Migration Task ` +- :ref:`Querying the Progress of an Online Migration Task ` +- :ref:`Creating an Online Data Migration Task ` +- :ref:`Configuring an Online Data Migration Task ` +- :ref:`Stopping Data Migration Tasks ` +- :ref:`Stopping Synchronization of a Data Migration Task ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_data_migration_task + listing_migration_tasks + deleting_data_migration_tasks + querying_details_of_a_data_migration_task + stopping_a_data_migration_task + querying_the_progress_of_an_online_migration_task + creating_an_online_data_migration_task + configuring_an_online_data_migration_task + stopping_data_migration_tasks + stopping_synchronization_of_a_data_migration_task diff --git a/api-ref/source/api_v2/data_migration/listing_migration_tasks.rst b/api-ref/source/api_v2/data_migration/listing_migration_tasks.rst new file mode 100644 index 0000000..5955507 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/listing_migration_tasks.rst @@ -0,0 +1,308 @@ +:original_name: ListMigrationTask_0.html + +.. _ListMigrationTask_0: + +Listing Migration Tasks +======================= + +Function +-------- + +This API is used to query the migration task list. + +URI +--- + +GET /v2/{project_id}/migration-tasks + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=====================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | name | No | String | Name of the migration task. | + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=============================================================================================+====================================================================================================+ + | count | Integer | Number of migration tasks. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | migration_tasks | Array of :ref:`MigrationTaskList ` objects | Migration task list. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | target_instance_address | String | Target instance address. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | migration_method | String | Type of the migration, which can be full migration or incremental migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **full_amount_migration** | + | | | | + | | | - **incremental_migration** | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | task_name | String | Name of the migration task. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | target_instance_id | String | Target instance ID. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | source_instance_name | String | Name of the source instance. If the source Redis is self-hosted, this parameter is left blank. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | target_instance_name | String | Target instance name. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | migrate_type | String | Mode of the migration, which can be backup file import or online migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **backupfile_import** | + | | | | + | | | - **online_migration** | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the migration task is created. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | source_instance_id | String | ID of the source instance. If the source Redis is self-hosted, this parameter is left blank. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | task_id | String | Migration task ID. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | data_source | String | Source Redis address, which is **ip:port** or a bucket name. | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | status | String | Migration task status. The value can be **SUCCESS**, **FAILED**, **MIGRATING**, or **TERMINATED**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **SUCCESS** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **MIGRATING** | + | | | | + | | | - **TERMINATED** | + +-------------------------+---------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. _listmigrationtask_0__response_migrationtasklist: + +.. table:: **Table 4** MigrationTaskList + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | task_id | String | Migration task ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | task_name | String | Migration task name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Migration task status. The value can be **SUCCESS**, **FAILED**, **MIGRATING**, or **TERMINATED**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **SUCCESS** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **MIGRATING** | + | | | | + | | | - **TERMINATED** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_type | String | Mode of the migration, which can be backup file import or online migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **backupfile_import** | + | | | | + | | | - **online_migration** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_method | String | Type of the migration, which can be full migration or incremental migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **full_amount_migration** | + | | | | + | | | - **incremental_migration** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs_tenant_private_ip | String | Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | data_source | String | Source Redis address, which is **ip:port** or a bucket name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_instance_name | String | Name of the source instance. If the source Redis is self-hosted, this parameter is left blank. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_instance_id | String | ID of the source instance. If the source Redis is self-hosted, this parameter is left blank. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance_addrs | String | Target Redis address. The format is **ip:port**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance_name | String | Target instance name. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance_id | String | Target instance ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the migration task is created. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks?offset=0&limit=10&name=dcs-migration-i9qk + +Example Responses +----------------- + +**Status code: 200** + +Querying the migration task list. + +.. code-block:: + + { + "task_id" : "2944a563-6f27-4604-9c16-a9a53cd95cc7", + "task_name" : "dcs-migration-test-6-16", + "status" : "TERMINATED", + "migrate_type" : "online_migration", + "migration_method" : "incremental_migration", + "data_source" : "192.168.0.200:6379", + "source_instance_name" : "migration-resource", + "source_instance_id" : "132e0017-715b-4556-930a-95c7db7e8f7a", + "target_instance_address" : "192.168.0.153:6379", + "target_instance_name" : "migration-target", + "target_instance_id" : "eb1a8d1c-9ea6-4fcd-ac43-c3d3c2493f06", + "created_at" : "2021-06-16T06:12:55.508Z" + } + +Status Codes +------------ + +=========== ==================================== +Status Code Description +=========== ==================================== +200 Querying the migration task list. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ==================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/querying_details_of_a_data_migration_task.rst b/api-ref/source/api_v2/data_migration/querying_details_of_a_data_migration_task.rst new file mode 100644 index 0000000..6c98a08 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/querying_details_of_a_data_migration_task.rst @@ -0,0 +1,309 @@ +:original_name: ShowMigrationTask_0.html + +.. _ShowMigrationTask_0: + +Querying Details of a Data Migration Task +========================================= + +Function +-------- + +This API is used to query migration task details. + +URI +--- + +GET /v2/{project_id}/migration-task/{task_id} + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + task_id Yes String Task ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================+=============================================================================================================================================================================================+ + | task_id | String | Migration task ID. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | task_name | String | Migration task name. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Migration task description. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Migration task status. The value can be **SUCCESS**, **FAILED**, **MIGRATING**, or **TERMINATED**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **SUCCESS** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **MIGRATING** | + | | | | + | | | - **TERMINATED** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_type | String | Mode of the migration, which can be backup file import or online migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **backupfile_import** | + | | | | + | | | - **online_migration** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_method | String | Type of the migration, which can be full migration or incremental migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **full_amount_migration** | + | | | | + | | | - **incremental_migration** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs_tenant_private_ip | String | Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_files | :ref:`BackupFilesBody ` object | Backup files to be imported when the migration mode is backup file import. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_type | String | Network type, which can be VPC or VPN. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **vpc** | + | | | | + | | | - **vpn** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_instance | :ref:`SourceInstanceBody ` object | Source Redis information. This parameter is mandatory for online migration. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance | :ref:`TargetInstanceBody ` object | Target Redis instance information. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the migration task is created. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the migration task is complete. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showmigrationtask_0__response_backupfilesbody: + +.. table:: **Table 3** BackupFilesBody + + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================+=========================================================================================================+ + | file_source | String | Data source, which can be an OBS bucket or a backup record. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **self_build_obs** | + | | | | + | | | - **backup_record** | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | bucket_name | String | Name of the OBS bucket. | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | files | Array of :ref:`Files ` objects | List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket. | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | backup_id | String | Backup record ID. This parameter is mandatory when the data source is a backup record. | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + +.. _showmigrationtask_0__response_files: + +.. table:: **Table 4** Files + + +-----------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==========================================================================+ + | file_name | String | Name of a backup file. | + +-----------+--------+--------------------------------------------------------------------------+ + | size | String | File size in bytes. | + +-----------+--------+--------------------------------------------------------------------------+ + | update_at | String | Time when the file was last modified. The format is YYYY-MM-DD HH:MM:SS. | + +-----------+--------+--------------------------------------------------------------------------+ + +.. _showmigrationtask_0__response_sourceinstancebody: + +.. table:: **Table 5** SourceInstanceBody + + +-----------+--------+---------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=====================================================================+ + | addrs | String | Source Redis name (specified in the **source_instance** parameter). | + +-----------+--------+---------------------------------------------------------------------+ + | password | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+--------+---------------------------------------------------------------------+ + +.. _showmigrationtask_0__response_targetinstancebody: + +.. table:: **Table 6** TargetInstanceBody + + +-----------+--------+-----------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=======================================================================+ + | id | String | Redis instance ID (mandatory in the **target_instance** parameter). | + +-----------+--------+-----------------------------------------------------------------------+ + | name | String | Redis instance name (specified in the **target_instance** parameter). | + +-----------+--------+-----------------------------------------------------------------------+ + | password | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+--------+-----------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/254d2280acb74d36a8b839746bcd7352 /migration-task/a276c1ffa0a54c2597fc824b917db317 + +Example Responses +----------------- + +**Status code: 200** + +Details of a data migration task queried successfully. + +.. code-block:: + + { + "task_name" : "migration1", + "task_id" : "a276c1ffa0a54c2597fc824b917db317", + "status" : "MIGRATING", + "migration_type" : "incremental_migration", + "network_type" : "vpc", + "source_instance" : { + "addrs" : "192.168.1.2:6379" + }, + "target_instance" : { + "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee", + "name" : "test-instance" + }, + "created_at" : "2019/10/22 14:44:30", + "updated_at" : "2019/10/22 18:00:00" + } + +Status Codes +------------ + +=========== ====================================================== +Status Code Description +=========== ====================================================== +200 Details of a data migration task queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ====================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/querying_the_progress_of_an_online_migration_task.rst b/api-ref/source/api_v2/data_migration/querying_the_progress_of_an_online_migration_task.rst new file mode 100644 index 0000000..3d2911a --- /dev/null +++ b/api-ref/source/api_v2/data_migration/querying_the_progress_of_an_online_migration_task.rst @@ -0,0 +1,211 @@ +:original_name: ShowMigrationTaskStats_0.html + +.. _ShowMigrationTaskStats_0: + +Querying the Progress of an Online Migration Task +================================================= + +Function +-------- + +This API is used to query progress details about an online migration task. + +URI +--- + +GET /v2/{project_id}/migration-task/{task_id}/stats + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + task_id Yes String Task ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-------------------------+---------+-----------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=========+=================================================================+ + | full_migration_progress | String | Percentage of the full migration progress. | + +-------------------------+---------+-----------------------------------------------------------------+ + | offset | String | Incremental migration offset. | + +-------------------------+---------+-----------------------------------------------------------------+ + | source_dbsize | String | Number of keys in the source Redis. | + +-------------------------+---------+-----------------------------------------------------------------+ + | target_dbsize | String | Number of keys in the target Redis. | + +-------------------------+---------+-----------------------------------------------------------------+ + | target_input_kbps | String | Key write traffic of the target Redis, in KB/s. | + +-------------------------+---------+-----------------------------------------------------------------+ + | target_ops | String | Number of concurrent operations per second on the target Redis. | + +-------------------------+---------+-----------------------------------------------------------------+ + | is_migrating | Boolean | Whether the migration task is in progress. | + +-------------------------+---------+-----------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: + + https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/31c6fd2b-2893-430b-90ff-d1adb8060585/stats + +Example Responses +----------------- + +**Status code: 200** + +Progress of the online migration task queried successfully. + +.. code-block:: + + { + "full_migration_progress" : 100, + "offset" : 100, + "source_dbsize" : 531221, + "target_dbsize" : 531211, + "target_input_kbps" : 50, + "target_ops" : 5300, + "is_migrating" : true + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4133", + "error_msg" : "Instance job is not found." + } + +Status Codes +------------ + +=========== =========================================================== +Status Code Description +=========== =========================================================== +200 Progress of the online migration task queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== =========================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/stopping_a_data_migration_task.rst b/api-ref/source/api_v2/data_migration/stopping_a_data_migration_task.rst new file mode 100644 index 0000000..db5d7b2 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/stopping_a_data_migration_task.rst @@ -0,0 +1,309 @@ +:original_name: StopMigrationTask_0.html + +.. _StopMigrationTask_0: + +Stopping a Data Migration Task +============================== + +Function +-------- + +This API is used to stop a data migration task. + +URI +--- + +POST /v2/{project_id}/migration-task/{task_id}/stop + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + task_id Yes String Task ID + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================+=============================================================================================================================================================================================+ + | task_id | String | Migration task ID. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | task_name | String | Migration task name. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Migration task description. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Migration task status. The value can be **SUCCESS**, **FAILED**, **MIGRATING**, or **TERMINATED**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **SUCCESS** | + | | | | + | | | - **FAILED** | + | | | | + | | | - **MIGRATING** | + | | | | + | | | - **TERMINATED** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_type | String | Mode of the migration, which can be backup file import or online migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **backupfile_import** | + | | | | + | | | - **online_migration** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | migration_method | String | Type of the migration, which can be full migration or incremental migration. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **full_amount_migration** | + | | | | + | | | - **incremental_migration** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs_tenant_private_ip | String | Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_files | :ref:`BackupFilesBody ` object | Backup files to be imported when the migration mode is backup file import. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_type | String | Network type, which can be VPC or VPN. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **vpc** | + | | | | + | | | - **vpn** | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | source_instance | :ref:`SourceInstanceBody ` object | Source Redis information. This parameter is mandatory for online migration. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | target_instance | :ref:`TargetInstanceBody ` object | Target Redis instance information. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the migration task is created. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the migration task is complete. | + +-----------------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _stopmigrationtask_0__response_backupfilesbody: + +.. table:: **Table 3** BackupFilesBody + + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================+=========================================================================================================+ + | file_source | String | Data source, which can be an OBS bucket or a backup record. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **self_build_obs** | + | | | | + | | | - **backup_record** | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | bucket_name | String | Name of the OBS bucket. | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | files | Array of :ref:`Files ` objects | List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket. | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | backup_id | String | Backup record ID. This parameter is mandatory when the data source is a backup record. | + +-----------------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + +.. _stopmigrationtask_0__response_files: + +.. table:: **Table 4** Files + + +-----------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==========================================================================+ + | file_name | String | Name of a backup file. | + +-----------+--------+--------------------------------------------------------------------------+ + | size | String | File size in bytes. | + +-----------+--------+--------------------------------------------------------------------------+ + | update_at | String | Time when the file was last modified. The format is YYYY-MM-DD HH:MM:SS. | + +-----------+--------+--------------------------------------------------------------------------+ + +.. _stopmigrationtask_0__response_sourceinstancebody: + +.. table:: **Table 5** SourceInstanceBody + + +-----------+--------+---------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=====================================================================+ + | addrs | String | Source Redis name (specified in the **source_instance** parameter). | + +-----------+--------+---------------------------------------------------------------------+ + | password | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+--------+---------------------------------------------------------------------+ + +.. _stopmigrationtask_0__response_targetinstancebody: + +.. table:: **Table 6** TargetInstanceBody + + +-----------+--------+-----------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=======================================================================+ + | id | String | Redis instance ID (mandatory in the **target_instance** parameter). | + +-----------+--------+-----------------------------------------------------------------------+ + | name | String | Redis instance name (specified in the **target_instance** parameter). | + +-----------+--------+-----------------------------------------------------------------------+ + | password | String | Redis password. If a password is set, this parameter is mandatory. | + +-----------+--------+-----------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca/stop + +Example Responses +----------------- + +**Status code: 200** + +Data migration task stopped successfully. + +.. code-block:: + + { + "task_name" : "migration1", + "task_id" : "a276c1ffa0a54c2597fc824b917db317", + "status" : "TERMINATING", + "migration_type" : "incremental_migration", + "network_type" : "vpc", + "source_instance" : { + "addrs" : "192.168.1.2:6379" + }, + "target_instance" : { + "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee", + "name" : "test-instance" + }, + "created_at" : "2019/10/22 14:44:30", + "updated_at" : "2019/10/22 18:00:00" + } + +Status Codes +------------ + +=========== ========================================= +Status Code Description +=========== ========================================= +200 Data migration task stopped successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ========================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/stopping_data_migration_tasks.rst b/api-ref/source/api_v2/data_migration/stopping_data_migration_tasks.rst new file mode 100644 index 0000000..094e8fe --- /dev/null +++ b/api-ref/source/api_v2/data_migration/stopping_data_migration_tasks.rst @@ -0,0 +1,239 @@ +:original_name: BatchStopMigrationTasks_0.html + +.. _BatchStopMigrationTasks_0: + +Stopping Data Migration Tasks +============================= + +Function +-------- + +This API is used to stop data migration tasks in batches. If a success response is returned, the request is successfully delivered. The migration tasks are stopped only when their status is **TERMINATED**. + +URI +--- + +POST /v2/{project_id}/migration-task/batch-stop + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + =============== ========= ================ ========================= + Parameter Mandatory Type Description + =============== ========= ================ ========================= + migration_tasks Yes Array of strings Data migration task list. + =============== ========= ================ ========================= + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------+---------------------------------------------------------------------------------------------------------------+---------------------------+ + | Parameter | Type | Description | + +=================+===============================================================================================================+===========================+ + | migration_tasks | Array of :ref:`StopMigrationTaskResult ` objects | Data migration task list. | + +-----------------+---------------------------------------------------------------------------------------------------------------+---------------------------+ + +.. _batchstopmigrationtasks_0__response_stopmigrationtaskresult: + +.. table:: **Table 4** StopMigrationTaskResult + + +-----------------------+-----------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================+ + | result | String | Result of delivering the request for stopping migration tasks. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **success** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------+----------------------------------------------------------------+ + | task_id | String | ID of the data migration task. | + +-----------------------+-----------------------+----------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/migration-task/batch-stop + + { + "migration_tasks" : [ "b21989ec-2889-4b8e-99db-19c073425ec2", "5130d57f-640a-435b-bc3a-0fb1860a5340" ] + } + +Example Responses +----------------- + +**Status code: 200** + +"Migration tasks are being stopped. + +.. note:: + + The migration tasks are stopped when their status is **TERMINATED**. + +.. code-block:: + + { + "migration_tasks" : [ { + "result" : "success", + "task_id" : "b21989ec-2889-4b8e-99db-19c073425ec2" + }, { + "result" : "failed", + "task_id" : "5130d57f-640a-435b-bc3a-0fb1860a5340" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_msg" : "invalid migration task id in the request.", + "error_code" : "DCS.4855" + } + +Status Codes +------------ + ++-----------------------------------+-------------------------------------------------------------------------+ +| Status Code | Description | ++===================================+=========================================================================+ +| 200 | "Migration tasks are being stopped. | +| | | +| | .. note:: | +| | | +| | The migration tasks are stopped when their status is **TERMINATED**. | ++-----------------------------------+-------------------------------------------------------------------------+ +| 400 | Invalid request. | ++-----------------------------------+-------------------------------------------------------------------------+ +| 401 | Invalid authentication information. | ++-----------------------------------+-------------------------------------------------------------------------+ +| 403 | The request is rejected. | ++-----------------------------------+-------------------------------------------------------------------------+ +| 404 | The requested resource is not found. | ++-----------------------------------+-------------------------------------------------------------------------+ +| 500 | Internal service error. | ++-----------------------------------+-------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/data_migration/stopping_synchronization_of_a_data_migration_task.rst b/api-ref/source/api_v2/data_migration/stopping_synchronization_of_a_data_migration_task.rst new file mode 100644 index 0000000..80a4931 --- /dev/null +++ b/api-ref/source/api_v2/data_migration/stopping_synchronization_of_a_data_migration_task.rst @@ -0,0 +1,167 @@ +:original_name: StopMigrationTaskSync_0.html + +.. _StopMigrationTaskSync_0: + +Stopping Synchronization of a Data Migration Task +================================================= + +Function +-------- + +This API is used to stop synchronization of a data migration task. + +URI +--- + +POST /v2/{project_id}/migration-task/{task_id}/sync-stop + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + task_id Yes String Task ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +None + +Example Responses +----------------- + +None + +Status Codes +------------ + ++-------------+----------------------------------------------------------------+ +| Status Code | Description | ++=============+================================================================+ +| 204 | Synchronization of a data migration task stopped successfully. | ++-------------+----------------------------------------------------------------+ +| 400 | Invalid request. | ++-------------+----------------------------------------------------------------+ +| 401 | Invalid authentication information. | ++-------------+----------------------------------------------------------------+ +| 403 | The request is rejected. | ++-------------+----------------------------------------------------------------+ +| 404 | The requested resource is not found. | ++-------------+----------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+----------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/index.rst b/api-ref/source/api_v2/index.rst new file mode 100644 index 0000000..d440403 --- /dev/null +++ b/api-ref/source/api_v2/index.rst @@ -0,0 +1,38 @@ +:original_name: dcs-api-0605001.html + +.. _dcs-api-0605001: + +API V2 +====== + +- :ref:`Lifecycle Management ` +- :ref:`Instance Management ` +- :ref:`Shards and Replicas ` +- :ref:`Parameter Management ` +- :ref:`Backup and Restoration ` +- :ref:`Data Migration ` +- :ref:`Tag Management ` +- :ref:`Cache Analysis ` +- :ref:`Log Management ` +- :ref:`Network Security ` +- :ref:`Background Task Management ` +- :ref:`Template Management ` +- :ref:`Other APIs ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + lifecycle_management/index + instance_management/index + shards_and_replicas/index + parameter_management/index + backup_and_restoration/index + data_migration/index + tag_management/index + cache_analysis/index + log_management/index + network_security/index + background_task_management/index + template_management/index + other_apis/index diff --git a/api-ref/source/api_v2/instance_management/changing_the_password.rst b/api-ref/source/api_v2/instance_management/changing_the_password.rst new file mode 100644 index 0000000..681ebb7 --- /dev/null +++ b/api-ref/source/api_v2/instance_management/changing_the_password.rst @@ -0,0 +1,161 @@ +:original_name: UpdatePassword_0.html + +.. _UpdatePassword_0: + +Changing the Password +===================== + +Function +-------- + +This API is used to change the password of a DCS instance. + +URI +--- + +PUT /v2/{project_id}/instances/{instance_id}/password + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + ============ ========= ====== ============= + Parameter Mandatory Type Description + ============ ========= ====== ============= + old_password No String Old password. + new_password No String New password. + ============ ========= ====== ============= + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================================================================================+ + | lock_time | String | Lock duration. If the password authentication fails and the account is locked, the value of this parameter is not **null**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | result | String | Password change result: | + | | | | + | | | - **success**: Password is changed successfully. | + | | | | + | | | - **passwordFailed**: Password authentication failed. | + | | | | + | | | - **locked**: The account has been locked. | + | | | | + | | | - **failed**: Password change failed. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **success** | + | | | | + | | | - **passwordFailed** | + | | | | + | | | - **locked** | + | | | | + | | | - **failed** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | lock_time_left | String | Remaining time before the account is unlocked. When the account is locked, the value of this parameter is not **null**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | retry_times_left | String | Number of remaining password attempts. If the password authentication fails, a response is returned and is not **null**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + | message | String | Modification result description. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password + + { + "old_password" : "XXXXXX", + "new_password" : "XXXXXX" + } + +Example Responses +----------------- + +**Status code: 200** + +Password is changed successfully. + +.. code-block:: + + { + "lock_time" : "0", + "result" : "success", + "lock_time_left" : "0", + "retry_times_left" : "5", + "message" : "Modify DCSInstance password success." + } + +Status Codes +------------ + +=========== ================================= +Status Code Description +=========== ================================= +200 Password is changed successfully. +400 Invalid request. +500 Internal service error. +=========== ================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/instance_management/index.rst b/api-ref/source/api_v2/instance_management/index.rst new file mode 100644 index 0000000..d00e4bb --- /dev/null +++ b/api-ref/source/api_v2/instance_management/index.rst @@ -0,0 +1,24 @@ +:original_name: InstanceManagement_0.html + +.. _InstanceManagement_0: + +Instance Management +=================== + +- :ref:`Master/Standby Switchover ` +- :ref:`Changing the Password ` +- :ref:`Resetting a Password ` +- :ref:`Restarting DCS Instances or Clearing DCS Instance Data ` +- :ref:`Querying Statistics of All Running Instances ` +- :ref:`Modifying the Bandwidth of an Instance ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + master_standby_switchover + changing_the_password + resetting_a_password + restarting_dcs_instances_or_clearing_dcs_instance_data + querying_statistics_of_all_running_instances + modifying_the_bandwidth_of_an_instance diff --git a/api-ref/source/api_v2/instance_management/master_standby_switchover.rst b/api-ref/source/api_v2/instance_management/master_standby_switchover.rst new file mode 100644 index 0000000..6327132 --- /dev/null +++ b/api-ref/source/api_v2/instance_management/master_standby_switchover.rst @@ -0,0 +1,174 @@ +:original_name: ChangeMasterStandby_0.html + +.. _ChangeMasterStandby_0: + +Master/Standby Switchover +========================= + +Function +-------- + +This API is used to perform a master/standby switchover. Only master/standby instances support this operation. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/swap + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/swap + +Example Responses +----------------- + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_msg" : "Master standby swap is not supported.", + "error_code" : "DCS.4855", + "error_ext_msg" : null + } + +Status Codes +------------ + +=========== ================================================= +Status Code Description +=========== ================================================= +204 Master/standby switchover performed successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/instance_management/modifying_the_bandwidth_of_an_instance.rst b/api-ref/source/api_v2/instance_management/modifying_the_bandwidth_of_an_instance.rst new file mode 100644 index 0000000..6ea9ea5 --- /dev/null +++ b/api-ref/source/api_v2/instance_management/modifying_the_bandwidth_of_an_instance.rst @@ -0,0 +1,101 @@ +:original_name: UpdateInstanceBandwidth_0.html + +.. _UpdateInstanceBandwidth_0: + +Modifying the Bandwidth of an Instance +====================================== + +Function +-------- + +This API is used to modify the bandwidth of a specified instance. + +URI +--- + +PUT /v2/{project_id}/instances/{instance_id}/bandwidth + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 2** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/bandwidth + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ======================= +Status Code Description +=========== ======================= +200 Bandwidth modified. +400 Invalid request. +500 Internal service error. +=========== ======================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/instance_management/querying_statistics_of_all_running_instances.rst b/api-ref/source/api_v2/instance_management/querying_statistics_of_all_running_instances.rst new file mode 100644 index 0000000..456f1e5 --- /dev/null +++ b/api-ref/source/api_v2/instance_management/querying_statistics_of_all_running_instances.rst @@ -0,0 +1,184 @@ +:original_name: ListStatisticsOfRunningInstances_0.html + +.. _ListStatisticsOfRunningInstances_0: + +Querying Statistics of All Running Instances +============================================ + +Function +-------- + +This API is used to query the statistics of all DCS instances that are in the **Running** state. + +URI +--- + +GET /v2/{project_id}/instances/statistic + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +------------+------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +============+============================================================================================================+=======================================================+ + | statistics | Array of :ref:`InstanceStatistic ` objects | Statistics of all instances in the **Running** state. | + +------------+------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ + +.. _liststatisticsofrunninginstances_0__response_instancestatistic: + +.. table:: **Table 3** InstanceStatistic + + +---------------+--------+--------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+========+============================================================================================+ + | input_kbps | String | Incoming traffic (kbit/s) of the DCS instance. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | output_kbps | String | Outgoing traffic (kbit/s) of the DCS instance. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | keys | Long | Number of cached data records | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | used_memory | Long | Used memory size in MB. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | max_memory | Long | Total memory size in MB. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | cmd_get_count | Long | Number of times the GET command is run. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | cmd_set_count | Long | Number of times the SET command is run. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + | used_cpu | String | Accumulated CPU time consumed by the cache in the user state and kernel state, in seconds. | + +---------------+--------+--------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/statistic + +Example Responses +----------------- + +**Status code: 200** + +Instance statistics queried successfully. + +.. code-block:: + + { + "statistics" : [ { + "output_kbps" : "0.0", + "instance_id" : "e008652d-18e0-43ff-924e-072261e0372a", + "keys" : 0, + "used_memory" : 0, + "cmd_get_count" : 0, + "used_cpu" : "0.0", + "cmd_set_count" : 0, + "input_kbps" : "0.0", + "max_memory" : 460 + }, { + "output_kbps" : "0.0", + "instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac", + "keys" : 0, + "used_memory" : 0, + "cmd_get_count" : 0, + "used_cpu" : "0.0", + "cmd_set_count" : 0, + "input_kbps" : "0.0", + "max_memory" : 460 + }, { + "output_kbps" : "1.19", + "instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207", + "keys" : 0, + "used_memory" : 0, + "cmd_get_count" : 0, + "used_cpu" : "0.0", + "cmd_set_count" : 0, + "input_kbps" : "0.03", + "max_memory" : 460 + }, { + "output_kbps" : "0.0", + "instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba", + "keys" : 0, + "used_memory" : 0, + "cmd_get_count" : 0, + "used_cpu" : "0.0", + "cmd_set_count" : 0, + "input_kbps" : "0.0", + "max_memory" : 6963 + } ] + } + +Status Codes +------------ + +=========== ========================================= +Status Code Description +=========== ========================================= +200 Instance statistics queried successfully. +400 Invalid request. +500 Internal service error. +=========== ========================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/instance_management/resetting_a_password.rst b/api-ref/source/api_v2/instance_management/resetting_a_password.rst new file mode 100644 index 0000000..8163235 --- /dev/null +++ b/api-ref/source/api_v2/instance_management/resetting_a_password.rst @@ -0,0 +1,131 @@ +:original_name: ResetPassword_0.html + +.. _ResetPassword_0: + +Resetting a Password +==================== + +Function +-------- + +This API is used to reset the password of a DCS instance. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/password/reset + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +--------------------+-----------+---------+------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +====================+===========+=========+======================================================+ + | new_password | No | String | New password | + +--------------------+-----------+---------+------------------------------------------------------+ + | no_password_access | No | Boolean | Whether to change the DCS instance to password-free. | + +--------------------+-----------+---------+------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ================ ====== ====================================== + Parameter Type Description + ================ ====== ====================================== + retry_times_left String Number of remaining password attempts. + lock_time String Lockout time. + lock_time_left String Remaining time before unlocking. + ================ ====== ====================================== + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/password/reset + +Example Responses +----------------- + +**Status code: 200** + +The password is changed successfully. + +.. code-block:: + + { + "lock_time" : "0", + "lock_time_left" : "0", + "retry_times_left" : "5" + } + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +200 The password is changed successfully. +400 Invalid request. +500 Internal service error. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/instance_management/restarting_dcs_instances_or_clearing_dcs_instance_data.rst b/api-ref/source/api_v2/instance_management/restarting_dcs_instances_or_clearing_dcs_instance_data.rst new file mode 100644 index 0000000..686f987 --- /dev/null +++ b/api-ref/source/api_v2/instance_management/restarting_dcs_instances_or_clearing_dcs_instance_data.rst @@ -0,0 +1,160 @@ +:original_name: RestartOrFlushInstances_0.html + +.. _RestartOrFlushInstances_0: + +Restarting DCS Instances or Clearing DCS Instance Data +====================================================== + +Function +-------- + +This API is used to restart running DCS instances. + +Data clearance operations cannot be undone on DCS Redis 4.0/5.0/6.0 instances. + +URI +--- + +PUT /v2/{project_id}/instances/status + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-----------------+-----------------+------------------+---------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+===============================================================+ + | instances | No | Array of strings | List of instance IDs. | + +-----------------+-----------------+------------------+---------------------------------------------------------------+ + | action | No | String | Operation on the instance: | + | | | | | + | | | | **restart**: force restart | + | | | | | + | | | | **soft_restart**: restart only the process | + | | | | | + | | | | **flush**: clear data | + | | | | | + | | | | .. note:: | + | | | | | + | | | | Only DCS Redis 4.0, 5.0, and 6.0 instances can be flushed. | + +-----------------+-----------------+------------------+---------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=============================================================================================+==================================================================+ + | results | Array of :ref:`BatchOpsResult ` objects | Result of deleting, restarting, or clearing data of an instance. | + +-----------+---------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + +.. _restartorflushinstances_0__response_batchopsresult: + +.. table:: **Table 4** BatchOpsResult + + +-----------+--------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+================================================================+ + | result | String | Instance deletion result. Options: **success** and **failed**. | + +-----------+--------+----------------------------------------------------------------+ + | instance | String | DCS instance ID. | + +-----------+--------+----------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/{project_id}/instances/status + + { + "instances" : [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ], + "action" : "restart" + } + +Example Responses +----------------- + +**Status code: 200** + +DCS instances restarted successfully or the instance data cleared successfully. + +.. code-block:: + + { + "results" : [ { + "instance" : "e3a7019c-8824-4c1a-8289-5300f19b9f64", + "result" : "success" + } ] + } + +Status Codes +------------ + ++-------------+---------------------------------------------------------------------------------+ +| Status Code | Description | ++=============+=================================================================================+ +| 200 | DCS instances restarted successfully or the instance data cleared successfully. | ++-------------+---------------------------------------------------------------------------------+ +| 400 | Invalid request. | ++-------------+---------------------------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+---------------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/batch_deleting_dcs_instances.rst b/api-ref/source/api_v2/lifecycle_management/batch_deleting_dcs_instances.rst new file mode 100644 index 0000000..a880a34 --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/batch_deleting_dcs_instances.rst @@ -0,0 +1,160 @@ +:original_name: BatchDeleteInstances_0.html + +.. _BatchDeleteInstances_0: + +Batch Deleting DCS Instances +============================ + +Function +-------- + +This API is used to delete multiple DCS instances at a time. + +URI +--- + +DELETE /v2/{project_id}/instances + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================================================+ + | all_failure | No | Boolean | Whether to delete all DCS instances that failed to be created. Values: | + | | | | | + | | | | - **true**: all instances that fail to be created are deleted. In this case, the **instances** parameter in the request can be empty. | + | | | | | + | | | | - **false** or other values: The DCS instances specified by the **instances** parameter will be deleted. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 3** Request body parameters + + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+================================================================================================================+ + | instances | No | Array of strings | List of instance IDs. | + | | | | | + | | | | This parameter is set only when the **all_failure** parameter in the URI is set to **false** or another value. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 4** Response body parameters + + +-----------+------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==========================================================================================+==================================================================+ + | results | Array of :ref:`BatchOpsResult ` objects | Result of deleting, restarting, or clearing data of an instance. | + +-----------+------------------------------------------------------------------------------------------+------------------------------------------------------------------+ + +.. _batchdeleteinstances_0__response_batchopsresult: + +.. table:: **Table 5** BatchOpsResult + + +-----------+--------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+================================================================+ + | result | String | Instance deletion result. Options: **success** and **failed**. | + +-----------+--------+----------------------------------------------------------------+ + | instance | String | DCS instance ID. | + +-----------+--------+----------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/{project_id}/instances?all_failure={all_failure} + + { + "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ] + } + +Example Responses +----------------- + +**Status code: 200** + +DCS instances deleted successfully. + +.. code-block:: + + { + "results" : [ { + "result" : "success", + "instance" : "54602a9d-5e22-4239-9123-77e350df4a34" + }, { + "result" : "success", + "instance" : "7166cdea-dbad-4d79-9610-7163e6f8b640" + } ] + } + +Status Codes +------------ + +=========== =================================== +Status Code Description +=========== =================================== +200 DCS instances deleted successfully. +500 Internal service error. +400 Invalid request. +=========== =================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/creating_a_dcs_instance.rst b/api-ref/source/api_v2/lifecycle_management/creating_a_dcs_instance.rst new file mode 100644 index 0000000..855be8c --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/creating_a_dcs_instance.rst @@ -0,0 +1,588 @@ +:original_name: CreateInstance_0.html + +.. _CreateInstance_0: + +Creating a DCS Instance +======================= + +Function +-------- + +This API is used to create a DCS instance which is billed in pay-per-use mode. + +URI +--- + +POST /v2/{project_id}/instances + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=========================+=================+=============================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | Yes | String | Instance name. | + | | | | | + | | | | An instance name can contain letters, digits, underscores (_), and hyphens (-), and must start with a letter. | + | | | | | + | | | | When you create only one instance at a time, the value of this parameter can contain 4 to 64 characters. When you create multiple instances at a time, the value of this parameter can contain 4 to 56 characters. The instances are named in the format of *custom name*\ ``-``\ *n*, where *n* starts from 000 and is incremented by 1. For example, if you create two instances and set the custom name to **dcs_demo**, the two instances are respectively named **dcs_demo-000** and **dcs_demo-001**. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine | Yes | String | Cache engine: Redis. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_version | No | String | Cache version. | + | | | | | + | | | | If the cache engine is Redis, the value can be **3.0**/**4.0**/5.0/6.0. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity | Yes | Float | Cache capacity (GB). | + | | | | | + | | | | - For a single-node or master/standby DCS Redis4.0, 5.0, or 6.0 instance, the value can be **0.125**, **0.25**, **0.5**, **1**, **2**, **4**, **8**, **16**, **32**, or **64**. For a Redis Cluster DCS Redis 4.0 or 5.0 instance, the value can be **24**, **32**, **48**, **64**, **96**, **128**, **192**, **256**, **384**, **512**, **768**, or **1024**. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code | Yes | String | Product flavor. The query method is as follows: | + | | | | | + | | | | - Method 1: Read the . | + | | | | | + | | | | - Method 2: Log in to the DCS console, go to the instance creation page, and check the instance flavor. | + | | | | | + | | | | - Method 3: Call the API used to . | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_codes | Yes | Array of strings | ID of the AZ where the cache node resides and which has available resources. ID of the AZ where the cache node resides and which has available resources. For details, see . Check whether the AZ has available resources. | + | | | | | + | | | | Master/standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate multiple AZs. For details, see the example request. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | VPC ID. | + | | | | | + | | | | You can obtain it in either of the following ways: | + | | | | | + | | | | - Method 1: Log in to the VPC console and view the VPC ID in the VPC details. | + | | | | | + | | | | - Method 2: Call the VPC API. For details, see . | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | Yes | String | Subnet network ID. | + | | | | | + | | | | You can obtain it in either of the following ways: | + | | | | | + | | | | - Method 1: Log in to VPC console and click the target subnet on the **Subnets** tab page. You can view the network ID on the displayed page. | + | | | | | + | | | | - Method 2: Call the VPC API. For details, see . | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | No | String | ID of the security group to which the instance belongs. | + | | | | | + | | | | This parameter is optional when **engine** is **Redis** and **engine_version** is **4.0**, **5.0**, or **6.0**. DCS Redis 4.0, 5.0, and 6.0 instances do not support security groups. They support only whitelist-based access control. | + | | | | | + | | | | You can obtain it in either of the following ways: | + | | | | | + | | | | - Method 1: Log in to the VPC console and view the security group ID on the security group details page. | + | | | | | + | | | | - Method 2: Call the API used to query security group details. For details, see . | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_id | No | String | ID of the EIP bound to the DCS Redis instance. | + | | | | | + | | | | This parameter is mandatory if public access is enabled (that is, **enable_publicip** is set to **true**). | + | | | | | + | | | | Default: **false** | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | No | String | Name of an enterprise project. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Instance description. | + | | | | | + | | | | The description can contain a maximum of 1024 characters. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | The backslash () and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character () before the characters, for example, \\\\ and \\". | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_ssl | No | Boolean | Whether to enable SSL for public access to a DCS Redis instance. | + | | | | | + | | | | - **true**: enable | + | | | | | + | | | | - **false**: disable | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ip | No | String | IP address that is manually specified for a DCS instance. This parameter is available for DCS Redis instances. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_num | No | Integer | Number of instances to be created in batches. This parameter is available for DCS Redis instances. | + | | | | | + | | | | Default value: **1**. | + | | | | | + | | | | Value range: 1 to 100 | + | | | | | + | | | | Default: **1** | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_begin | No | String | UTC time when the maintenance time window starts. The format is HH:mm:ss. | + | | | | | + | | | | - The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see . | + | | | | | + | | | | - 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 and end time must be set in pairs. If the start time is left blank, the end time must also be left blank. In this case, the system automatically sets the start time to 02:00:00. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_end | No | String | UTC time when the maintenance time window ends. The format is HH:mm:ss. | + | | | | | + | | | | - The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see . | + | | | | | + | | | | - The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00. | + | | | | | + | | | | - The start time and end time must be set in pairs. If the end time is left blank, the start time is also left blank. In this case, the system automatically sets the end time to 06:00:00. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | password | No | String | DCS instance authentication information. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | When **no_password_access** is set to **false** or not specified, the request must contain the **password** parameter. The password of a DCS Redis instance must meet the following complexity requirements: | + | | | | | + | | | | - Can be 8 to 32 characters long. | + | | | | | + | | | | - The new password must be different from the old password. | + | | | | | + | | | | - Contains at least three of the following character types: | + | | | | | + | | | | - Lowercase letters | + | | | | | + | | | | - Uppercase letters | + | | | | | + | | | | - Digits | + | | | | | + | | | | - Special characters :literal:`\`~!@#$%^&*()-_=+\\|[{}]:'"",<.>/?` | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | no_password_access | No | Boolean | Whether the instance can be accessed without a password. | + | | | | | + | | | | - **true**: The instance can be accessed without a password. | + | | | | | + | | | | - **false**: The instance can be accessed only after password authentication. If this parameter is not set, the default value **false** is used. | + | | | | | + | | | | Default: **false** | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bss_param | No | :ref:`BssParam ` object | Parameter related to the yearly/monthly billing mode. If this parameter is left blank, the billing mode is pay-per-use by default. If this parameter is not left blank, the billing mode is yearly/monthly. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_backup_policy | No | :ref:`BackupPolicy ` object | Backup policy. This parameter is supported when the instance type is master/standby or cluster. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`ResourceTag ` objects | Instance tag key and value. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | access_user | No | String | If the cache engine is Redis, you do not need to set this parameter. | + | | | | | + | | | | A username can contain 1 to 64 characters and must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed. | + | | | | | + | | | | - If the cache engine is Redis, you do not need to set this parameter. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_publicip | No | Boolean | Whether to enable public network access for the DCS Redis instance. | + | | | | | + | | | | - **true**: enable | + | | | | | + | | | | - **false**: disable | + | | | | | + | | | | Default: **false** | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | No | Integer | Port customization. | + | | | | | + | | | | If this parameter is not sent or is left empty when you create a Redis 4.0, 5.0, or 6.0 instance, the default port 6379 will be used. To customize a port, specify a port number in the range from 1 to 65535. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rename_commands | No | Object | Critical command renaming. | + | | | | | + | | | | If this parameter is not sent or is left empty when you create a Redis 4.0, 5.0, or 6.0 instance, no critical command will be renamed. Currently, only **COMMAND**, **KEYS**, **FLUSHDB**, **FLUSHALL**, and **HGETALL** commands can be renamed. | + +-------------------------+-----------------+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createinstance_0__request_bssparam: + +.. table:: **Table 3** BssParam + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================+ + | is_auto_renew | No | String | This parameter is currently not used. | + | | | | | + | | | | Default: **false** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | charging_mode | Yes | String | Billing mode. The default value is **postPaid**, indicating pay-per-use. | + | | | | | + | | | | Default: **postPaid** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | is_auto_pay | No | String | This parameter is currently not used. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | period_type | No | String | This parameter is currently not used. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | period_num | No | Integer | This parameter is currently not used. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + +.. _createinstance_0__request_backuppolicy: + +.. table:: **Table 4** BackupPolicy + + +------------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+=================+=================================================================+===============================================================================================================================+ + | backup_type | Yes | String | Backup type. | + | | | | | + | | | | - **auto**: automatic backup | + | | | | | + | | | | - **manual**: manual backup | + +------------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | save_days | No | Integer | This parameter is mandatory when **backup_type** is set to **auto**. Retention period, in days. The value ranges from 1 to 7. | + +------------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + | periodical_backup_plan | No | :ref:`BackupPlan ` object | Backup schedule. This parameter is mandatory when **backup_type** is set to **auto**. | + +------------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ + +.. _createinstance_0__request_backupplan: + +.. table:: **Table 5** BackupPlan + + +-----------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+===================+==========================================================================================================================================================================+ + | timezone_offset | No | String | Time zone in which backup is performed. Range: GMT -12:00 to GMT +12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default. | + +-----------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_at | Yes | Array of integers | Day in a week on which backup starts. The value ranges from **1** to **7**, where **1** indicates Monday, and **7** indicates Sunday. | + +-----------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period_type | Yes | String | Interval at which backup is performed, which supports only **weekly** currently. | + +-----------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_at | Yes | String | Time at which backup starts. **00:00-01:00** indicates that the backup starts at 00:00. | + +-----------------+-----------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _createinstance_0__request_resourcetag: + +.. table:: **Table 6** ResourceTag + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================================================+ + | key | Yes | String | Tag key. | + | | | | | + | | | | - This field cannot be left blank. | + | | | | | + | | | | - The key value of a resource must be unique. | + | | | | | + | | | | - The tag key can contain a maximum of 36 characters. | + | | | | | + | | | | - The tag key must be unique and cannot be empty. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + | value | No | String | Tag value. | + | | | | | + | | | | - This parameter is mandatory when **action** is set to **create** and is optional when **action** is set to **delete**. | + | | | | | + | | | | - The tag value can contain a maximum of 43 characters. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 7** Response body parameters + + +-----------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==========================================================================+==================================================================================================================================+ + | order_id | String | Order ID. This parameter is not returned for pay-per-use instances. | + +-----------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`Instances ` objects | DCS instance ID and name. If multiple DCS instances are created at a time, multiple DCS instance IDs and names will be returned. | + +-----------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +.. _createinstance_0__response_instances: + +.. table:: **Table 8** Instances + + ============= ====== ================== + Parameter Type Description + ============= ====== ================== + instance_id String DCS instance ID. + instance_name String DCS instance name. + ============= ====== ================== + +**Status code: 400** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 11** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 12** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 13** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +- Creating a DCS Redis instance + + .. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instances + + { + "name" : "dcs-APITest", + "description" : "Test", + "engine" : "Redis", + "engine_version" : 5.0, + "enterprise_project_id" : 0, + "enterprise_project_name" : "default", + "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", + "security_group_id" : "securityGroupId", + "enable_ssl" : false, + "private_ip" : "", + "az_codes" : [ "region01" ], + "capacity" : 0, + "access_user" : "", + "maintain_begin" : "18:00:00", + "maintain_end" : "19:00:00", + "password" : "********", + "enable_publicip" : false, + "spec_code" : "redis.single.xu1.tiny.128", + "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af", + "no_password_access" : false + } + +- Creating a pay-per-use, master/standby DCS Redis instance with tags, a customized port, renamed commands, and cross-AZ deployment + + .. code-block:: + + { + "enterprise_project_name" : "default", + "vpc_id" : "c5cd009b-9ba9-41f2-9a26-2b8c3f3ffd39", + "description" : "Test", + "security_group_id" : "d57fad27-e3e9-43b7-9498-0a698ab63b27", + "port" : 4040, + "maintain_end" : "19:00:00", + "enable_ssl" : false, + "private_ip" : "", + "az_codes" : [ "region01", "region02" ], + "capacity" : 2, + "access_user" : "", + "instance_num" : 1, + "maintain_begin" : "18:00:00", + "enterprise_project_id" : 0, + "password" : "********", + "enable_publicip" : false, + "engine" : "Redis", + "spec_code" : "redis.ha.au1.large.2", + "name" : "dcs-demo", + "subnet_id" : "7e95c4d6-d7af-424c-a3cf-2be10968fe81", + "engine_version" : 4.0, + "no_password_access" : false, + "rename_commands" : { + "keys" : "keys001", + "flushdb" : "flushdb001", + "flushall" : "flushall001" + }, + "tags" : [ { + "key" : "dcs001", + "value" : 2 + }, { + "key" : "dcs003", + "value" : 4 + } ] + } + +Example Responses +----------------- + +**Status code: 200** + +The DCS instance creation task is submitted successfully. + +.. note:: + + If the instance status is **RUNNING**, the DCS instance has been successfully created. + +- Example 1 + + .. code-block:: + + { + "instances" : [ { + "instance_id" : "3c49fd6b-fc7c-419e-9644-b6cce008653f", + "instance_name" : "dcs-test005" + } ] + } + +- Example 2 + + .. code-block:: + + { + "instances" : [ { + "instance_id" : "77284d69-cd51-4bf1-aa30-2e60f055800c", + "instance_name" : "dcs-APITest1" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.1004", + "error_msg" : "Project ID does not match the token." + } + +**Status code: 401** + +Invalid authentication information. + +.. code-block:: + + { + "error_code" : "DCS.1001", + "error_msg" : "Invalid token." + } + +**Status code: 403** + +The request is rejected. + +.. code-block:: + + { + "error_code" : "DCS.2003", + "error_msg" : "This role does not have the permission to perform this operation." + } + +**Status code: 404** + +The requested resource is not found. + +.. code-block:: + + { + "error_code" : "DCS.4001", + "error_msg" : "The requested URL does not exist." + } + +**Status code: 500** + +Internal service error. + +.. code-block:: + + { + "error_code" : "DCS.5000", + "error_msg" : "Internal service error." + } + +Status Codes +------------ + ++-----------------------------------+-------------------------------------------------------------------------------------------+ +| Status Code | Description | ++===================================+===========================================================================================+ +| 200 | The DCS instance creation task is submitted successfully. | +| | | +| | .. note:: | +| | | +| | If the instance status is **RUNNING**, the DCS instance has been successfully created. | ++-----------------------------------+-------------------------------------------------------------------------------------------+ +| 400 | Invalid request. | ++-----------------------------------+-------------------------------------------------------------------------------------------+ +| 401 | Invalid authentication information. | ++-----------------------------------+-------------------------------------------------------------------------------------------+ +| 403 | The request is rejected. | ++-----------------------------------+-------------------------------------------------------------------------------------------+ +| 404 | The requested resource is not found. | ++-----------------------------------+-------------------------------------------------------------------------------------------+ +| 500 | Internal service error. | ++-----------------------------------+-------------------------------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/deleting_an_instance.rst b/api-ref/source/api_v2/lifecycle_management/deleting_an_instance.rst new file mode 100644 index 0000000..c5da11d --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/deleting_an_instance.rst @@ -0,0 +1,67 @@ +:original_name: DeleteSingleInstance_0.html + +.. _DeleteSingleInstance_0: + +Deleting an Instance +==================== + +Function +-------- + +This API is used to delete a specified DCS instance to free up all resources occupied by it. + +.. note:: + + To delete pay-per-use resources, perform operations in this section.. + +URI +--- + +DELETE /v2/{project_id}/instances/{instance_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Requests +---------------- + +.. code-block:: text + + DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id} + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ============================== +Status Code Description +=========== ============================== +204 Instance deleted successfully. +400 Invalid request. +500 Internal service error. +=========== ============================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/index.rst b/api-ref/source/api_v2/lifecycle_management/index.rst new file mode 100644 index 0000000..b66463d --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/index.rst @@ -0,0 +1,26 @@ +:original_name: LifecycleManagement_0.html + +.. _LifecycleManagement_0: + +Lifecycle Management +==================== + +- :ref:`Creating a DCS Instance ` +- :ref:`Querying All DCS Instances ` +- :ref:`Batch Deleting DCS Instances ` +- :ref:`Querying a DCS instance ` +- :ref:`Deleting an Instance ` +- :ref:`Modifying Details of a DCS Instance ` +- :ref:`Modifying Instance Specifications ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + creating_a_dcs_instance + querying_all_dcs_instances + batch_deleting_dcs_instances + querying_a_dcs_instance + deleting_an_instance + modifying_details_of_a_dcs_instance + modifying_instance_specifications diff --git a/api-ref/source/api_v2/lifecycle_management/modifying_details_of_a_dcs_instance.rst b/api-ref/source/api_v2/lifecycle_management/modifying_details_of_a_dcs_instance.rst new file mode 100644 index 0000000..6ab4b15 --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/modifying_details_of_a_dcs_instance.rst @@ -0,0 +1,181 @@ +:original_name: UpdateInstance_0.html + +.. _UpdateInstance_0: + +Modifying Details of a DCS Instance +=================================== + +Function +-------- + +This API is used to modify the information about a DCS instance, including the instance name, description, port, backup policy, start and end time of the maintenance window, and security group. + +URI +--- + +PUT /v2/{project_id}/instances/{instance_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+=================+===============================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Instance name. | + | | | | | + | | | | An instance name can contain letters, digits, underscores (_), and hyphens (-), and must start with a letter. | + | | | | | + | | | | When you create only one instance at a time, the value of this parameter can contain 4 to 64 characters. When you create multiple instances at a time, the value of this parameter can contain 4 to 56 characters. The instances are named in the format of *custom name*\ ``-``\ *n*, where *n* starts from 000 and is incremented by 1. For example, if you create two instances and set the custom name to **dcs_demo**, the two instances are respectively named **dcs_demo-000** and **dcs_demo-001**. | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Instance description. The description can contain a maximum of 1024 characters. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | The backslash (\\) and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character (\\) before the characters, for example, **\\\\** and **\\"**. | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **1024** | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | No | Integer | Change the port for connecting to the Redis instance. The port range is from 1 to 65535. After the port is changed, all connections to the Redis instance are interrupted, and services must connect to the new port. Only DCS Redis 4.0, 5.0, and 6.0 instances support port change. | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **65535** | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rename_commands | No | :ref:`RenameCommandResp ` object | Command renaming list. | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_begin | No | String | UTC time when the maintenance time window starts. The format is HH:mm:ss. ' | + | | | | | + | | | | - The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see the API for listing maintenance time windows. | + | | | | | + | | | | - For example, the start time must be 18:00:00, 19:00:00, and so on. | + | | | | | + | | | | - The start time and end time must be set in pairs. If the start time is left blank, the end time must also be left blank. | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_end | No | String | UTC time when the maintenance time window starts. The format is HH:mm:ss. ' | + | | | | | + | | | | - The start time and end time of the maintenance window must be within the time segment of a supported maintenance window. For details, see the API for listing maintenance time windows. | + | | | | | + | | | | - The end time is one hour later than the start time. For example, if the start time is 18:00:00, the end time is 19:00:00. | + | | | | | + | | | | - The start time and end time must be set in pairs. If the end time is left blank, the start time is also left blank. | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | No | String | 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. | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_backup_policy | No | :ref:`BackupPolicy ` object | Backup policy. This parameter is supported when the instance type is master/standby or cluster. | + +------------------------+-----------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _updateinstance_0__request_renamecommandresp: + +.. table:: **Table 3** RenameCommandResp + + ========= ========= ====== ===================== + Parameter Mandatory Type Description + ========= ========= ====== ===================== + command No String Command **COMMAND**. + flushall No String Command **FLUSHALL**. + flushdb No String Command **FLUSHDB**. + hgetall No String Command **HGETALL**. + keys No String Command **KEYS**. + ========= ========= ====== ===================== + +.. _updateinstance_0__request_backuppolicy: + +.. table:: **Table 4** BackupPolicy + + +------------------------+-----------------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+=================+=================================================================+=================================================================================================================================+ + | backup_type | Yes | String | Backup type. | + | | | | | + | | | | - **auto**: automatic backup | + | | | | | + | | | | - **manual**: manual backup | + +------------------------+-----------------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | save_days | No | Integer | This parameter is mandatory when **backup_type** is set to **manual**. Retention period, in days. The value ranges from 1 to 7. | + +------------------------+-----------------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | periodical_backup_plan | No | :ref:`BackupPlan ` object | Backup schedule. This parameter is mandatory when **backup_type** is set to **manual**. | + +------------------------+-----------------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _updateinstance_0__request_backupplan: + +.. table:: **Table 5** BackupPlan + + +-----------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+===================+=======================================================================================================================================+ + | timezone_offset | No | String | Time zone in which backup is performed. This parameter is no longer used. | + +-----------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | backup_at | Yes | Array of integers | Day in a week on which backup starts. The value ranges from **1** to **7**, where **1** indicates Monday, and **7** indicates Sunday. | + +-----------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | period_type | Yes | String | Interval at which backup is performed, which supports only **weekly** currently. | + +-----------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | begin_at | Yes | String | UTC time when the backup starts. For example, **00:00-01:00** indicates that the backup starts at 00:00 (UTC time). | + +-----------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +None + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id} + + { + "name" : "dcs002", + "description" : "instance description", + "port" : 6379, + "maintain_begin" : "18:00:00", + "maintain_end" : "19:00:00", + "security_group_id" : "18e9309f-f81a-4749-bb21-f74576292162", + "instance_backup_policy" : { + "backup_type" : "auto", + "save_days" : "1,", + "periodical_backup_plan" : { + "backup_at" : [ "1", "2", "3", "4", "6", "7" ], + "period_type" : "weekly", + "begin_at" : "00:00-01:00" + } + } + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== =================================== +Status Code Description +=========== =================================== +204 DCS instance modified successfully. +400 Invalid request. +500 Internal service error. +=========== =================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/modifying_instance_specifications.rst b/api-ref/source/api_v2/lifecycle_management/modifying_instance_specifications.rst new file mode 100644 index 0000000..f2454c3 --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/modifying_instance_specifications.rst @@ -0,0 +1,134 @@ +:original_name: ResizeInstance_0.html + +.. _ResizeInstance_0: + +Modifying Instance Specifications +================================= + +Function +-------- + +This API is used to modify specifications of a DCS instance in the **Running** state. + +Constraints +----------- + +Currently, the specifications of a Proxy Cluster DCS Redis 3.0 instance cannot be reduced. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/resize + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+=================+=========================================================================+===========================================================================================================================================================================================================================================================================================================================================================================================================+ + | spec_code | Yes | String | Flavor after the modification. The query method is as follows: | + | | | | | + | | | | - Method 1: Read the *Service Overview* document. | + | | | | | + | | | | - Method 2: Log in to the DCS console, click **Create DCS Instance**, and check the instance flavor. | + | | | | | + | | | | - Method 3: Call the API used to query product flavors. | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | new_capacity | Yes | Integer | New memory size of the DCS instance, in GB. For a single-node or master/standby DCS Redis 4.0, 5.0, or 6.0 instance, the value can be **0.125**, **0.25**, **0.5**, **1**, **2**, **4**, **8**, **16**, **32**, or **64**. For a Redis Cluster DCS Redis 4.0 or 5.0 instance, the value can be **24**, **32**, **48**, **64**, **96**, **128**, **192**, **256**, **384**, **512**, **768**, or **1024**. | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bss_param | No | :ref:`BssParamEntity ` object | This parameter does not need to be set for pay-per-use instances. | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | reserved_ip | No | Array of strings | IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards. | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | change_type | No | String | Modification type. Mandatory when the number of replicas of a DCS Redis 4.0 or 5.0 instance is modified. | + | | | | | + | | | | - **createReplication**: adding replicas | + | | | | | + | | | | - **deleteReplication**: deleting replicas | + | | | | | + | | | | - **instanceType**: changing the instance type. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **createReplication** | + | | | | | + | | | | - **deleteReplication** | + | | | | | + | | | | - **instanceType** | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | available_zones | No | Array of strings | Code of the AZ where each replica is in. This parameter is mandatory when you add replicas to a DCS Redis 4.0 or 5.0 instance. Before specifying an AZ, ensure that there are available resources in it. This parameter is mandatory when you delete replicas from a cluster instance. | + | | | | | + | | | | For details, see the API for querying AZs. | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_list | No | Array of strings | ID of the replica to delete. This parameter is mandatory when you delete replicas of a master/standby DCS Redis 4.0 or 5.0 instance. Currently, only one replica can be deleted at a time. | + | | | | | + | | | | For details, see the API for querying details of shards and replicas. | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | execute_immediately | No | Boolean | Whether to apply the change immediately. The default value is **true**. | + | | | | | + | | | | - **true**: Apply the change immediately. | + | | | | | + | | | | - **false**: Apply the change during the maintenance window. . | + +---------------------+-----------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _resizeinstance_0__request_bssparamentity: + +.. table:: **Table 3** BssParamEntity + + =========== ========= ====== ===================================== + Parameter Mandatory Type Description + =========== ========= ====== ===================================== + is_auto_pay No String This parameter is currently not used. + =========== ========= ====== ===================================== + +Response Parameters +------------------- + +None + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize + + { + "spec_code" : "redis.ha.xu1.tiny.r2.512", + "new_capacity" : 1, + "reserved_ip" : [ "192.168.0.125" ], + "change_type" : "createReplication", + "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ], + "node_list" : [ "ff80808282eee5f90183120188ae093e" ], + "execute_immediately" : true + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ================================================== +Status Code Description +=========== ================================================== +204 DCS instance specifications modified successfully. +=========== ================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/querying_a_dcs_instance.rst b/api-ref/source/api_v2/lifecycle_management/querying_a_dcs_instance.rst new file mode 100644 index 0000000..52df38f --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/querying_a_dcs_instance.rst @@ -0,0 +1,446 @@ +:original_name: ShowInstance_0.html + +.. _ShowInstance_0: + +Querying a DCS instance +======================= + +Function +-------- + +This API is used to query the details about a specified DCS instance. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id} + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==============================+====================================================================================+==============================================================================================================================================================================+ + | vpc_name | String | VPC name. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charging_mode | Integer | Billing mode. The value can be **0**: pay-per-use. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | user_name | String | Username. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the instance is created. Format: 2017-03-31T12:24:46.297Z | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Instance description | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_name | String | Security group name. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_memory | Integer | Total memory size in MB. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | used_memory | Integer | Used memory size in MB. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity | Integer | DCS instance cache capacity in GB. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity_minor | String | Capacity (GB) of a small DCS instance (smaller than 1 GB). | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_begin | String | UTC time when the maintenance time window starts. The format is HH:mm:ss. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_end | String | UTC time when the maintenance time window ends. The format is HH:mm:ss. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine | String | DCS instance engine. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | no_password_access | String | Indicates whether the instance can be accessed without a password. | + | | | | + | | | - **true**: The instance can be accessed without a password. | + | | | | + | | | - **false**: The instance can be accessed only after password authentication. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip | String | IP address for connecting to the DCS instance. For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_backup_policy | :ref:`InstanceBackupPolicy ` object | Backup policy. This parameter is supported when the instance type is master/standby or cluster. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_codes | Array of strings | AZ where the instance is in. The AZ code is returned. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | access_user | String | Username used for accessing a DCS instance after password authentication. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | Integer | Port of the DCS instance. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | user_id | String | User ID. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | Specification code. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_name | String | Subnet name. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_cidr | String | Subnet CIDR block. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_version | String | Cache version. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | order_id | String | Order ID. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | DCS instance status. For details, see "DCS Instance Statuses". | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name | String | Domain name of the instance. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | readonly_domain_name | String | Read-only domain name of the instance. This parameter is available only for master/standby instances. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_publicip | Boolean | Indicates whether public network access is enabled for the DCS Redis instance. | + | | | | + | | | - **true**: enable | + | | | | + | | | - **false**: disable | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_id | String | ID of the EIP bound to the DCS Redis instance. The value of this parameter is **null** if public access is disabled. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | EIP bound to the DCS Redis instance. The value of this parameter is **null** if public access is disabled. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_ssl | Boolean | Whether to SSL is enabled for public access to a DCS Redis instance. | + | | | | + | | | - **true**: enable | + | | | | + | | | - **false**: disable | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_upgrade | Boolean | Whether the instance has an upgrade task. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_task_id | String | Upgrade task ID. | + | | | | + | | | - If the value of **service_upgrade** is set to **true**, the value of this parameter is the ID of the upgrade task. | + | | | | + | | | - If the value of **service_upgrade** is set to **false**, the value of this parameter is empty. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backend_addrs | String | Backend address of a cluster instance. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | features | :ref:`Features ` object | Features supported by the instance. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name_info | :ref:`DomainNameInfo ` object | Information about instance domain name update and public domain name resolution. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | transparent_client_ip_enable | Boolean | Whether client IP pass-through is enabled. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sub_status | String | Instance sub-status. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`ResourceTag ` objects | Instance tag key and value. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cpu_type | String | CPU type of the instance. Generally, the value is **x86_64** or **aarch64**. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_name | String | Enterprise project name. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | update_at | String | Update time, for example, 2022-07-06T09:32:16.502Z. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | product_type | String | Edition: community edition or professional edition. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **generic** | + | | | | + | | | - **enterprise** | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | storage_type | String | Storage type (DRAM). | + | | | | + | | | Enumeration values: | + | | | | + | | | - **DRAM** | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | launched_at | String | Start time, for example, 2022-07-06T09:32:16.502Z. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cache_mode | String | DCS instance type. Options: | + | | | | + | | | - **single**: single-node | + | | | | + | | | - **ha**: master/standby | + | | | | + | | | - **cluster**: Redis Cluster | + | | | | + | | | - **proxy**: Proxy Cluster | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | support_slow_log_flag | String | Whether slow query logs are supported. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | db_number | Integer | Number of databases. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | replica_count | Integer | Number of replicas. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sharding_count | Integer | Number of shards in a cluster instance. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_info | :ref:`BandwidthInfo ` object | Bandwidth information. | + +------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showinstance_0__response_instancebackuppolicy: + +.. table:: **Table 3** InstanceBackupPolicy + + +------------------+--------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +==================+====================================================================+==================================================+ + | backup_policy_id | String | Backup policy ID. | + +------------------+--------------------------------------------------------------------+--------------------------------------------------+ + | created_at | String | Creation time. Example: 2022-04-11T09:45:24.790Z | + +------------------+--------------------------------------------------------------------+--------------------------------------------------+ + | updated_at | String | Update time. Example: 2022-04-12T02:22:03.269Z | + +------------------+--------------------------------------------------------------------+--------------------------------------------------+ + | policy | :ref:`BackupPolicy ` object | Backup policy. | + +------------------+--------------------------------------------------------------------+--------------------------------------------------+ + | tenant_id | String | Account ID. | + +------------------+--------------------------------------------------------------------+--------------------------------------------------+ + +.. _showinstance_0__response_backuppolicy: + +.. table:: **Table 4** BackupPolicy + + +------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+================================================================+=================================================================================================================================+ + | backup_type | String | Backup type. | + | | | | + | | | - **auto**: automatic backup | + | | | | + | | | - **manual**: manual backup | + +------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | save_days | Integer | This parameter is mandatory when **backup_type** is set to **manual**. Retention period, in days. The value ranges from 1 to 7. | + +------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | periodical_backup_plan | :ref:`BackupPlan ` object | Backup schedule. This parameter is mandatory when **backup_type** is set to **manual**. | + +------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +.. _showinstance_0__response_backupplan: + +.. table:: **Table 5** BackupPlan + + +-----------------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+===================+=======================================================================================================================================+ + | timezone_offset | String | Time zone in which backup is performed. This parameter is no longer used. | + +-----------------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | backup_at | Array of integers | Day in a week on which backup starts. The value ranges from **1** to **7**, where **1** indicates Monday, and **7** indicates Sunday. | + +-----------------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | period_type | String | Interval at which backup is performed, which supports only **weekly** currently. | + +-----------------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | begin_at | String | UTC time when the backup starts. For example, **00:00-01:00** indicates that the backup starts at 00:00 (UTC time). | + +-----------------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +.. _showinstance_0__response_features: + +.. table:: **Table 6** Features + + +-------------------------------+-----------------------+--------------------------------------------+ + | Parameter | Type | Description | + +===============================+=======================+============================================+ + | support_acl | Boolean | Whether ACL is supported. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-------------------------------+-----------------------+--------------------------------------------+ + | support_transparent_client_ip | Boolean | Whether client IP pass-through is enabled. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-------------------------------+-----------------------+--------------------------------------------+ + | support_ssl | Boolean | Whether SSL is supported. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-------------------------------+-----------------------+--------------------------------------------+ + +.. _showinstance_0__response_domainnameinfo: + +.. table:: **Table 7** DomainNameInfo + + +------------------------+--------------------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +========================+======================================================================================+==================================================+ + | support_public_resolve | Boolean | Whether to enable public domain name resolution. | + | | | | + | | | - **true**: enable | + | | | | + | | | - **false**: disable | + +------------------------+--------------------------------------------------------------------------------------+--------------------------------------------------+ + | is_latest_rules | Boolean | Whether the current domain name is the latest. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +------------------------+--------------------------------------------------------------------------------------+--------------------------------------------------+ + | zone_name | String | Region suffix of the domain name. | + +------------------------+--------------------------------------------------------------------------------------+--------------------------------------------------+ + | history_domain_names | Array of :ref:`DomainNameEntity ` objects | Historical domain name information. | + +------------------------+--------------------------------------------------------------------------------------+--------------------------------------------------+ + +.. _showinstance_0__response_domainnameentity: + +.. table:: **Table 8** DomainNameEntity + + +-----------------------+-----------------------+------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================+ + | domain_name | String | Historical domain names of the instance. | + +-----------------------+-----------------------+------------------------------------------+ + | is_readonly | Boolean | Whether the domain name is read-only. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-----------------------+-----------------------+------------------------------------------+ + +.. _showinstance_0__response_resourcetag: + +.. table:: **Table 9** ResourceTag + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================================+ + | key | String | Tag key. | + | | | | + | | | - This field cannot be left blank. | + | | | | + | | | - The key value of a resource must be unique. | + | | | | + | | | - The tag key can contain a maximum of 36 characters. | + | | | | + | | | - The tag key must be unique and cannot be empty. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value. | + | | | | + | | | - This parameter is mandatory when **action** is set to **create** and is optional when **action** is set to **delete**. | + | | | | + | | | - The tag value can contain a maximum of 43 characters. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + +.. _showinstance_0__response_bandwidthinfo: + +.. table:: **Table 10** BandwidthInfo + + ==================== ======= ===================================== + Parameter Type Description + ==================== ======= ===================================== + begin_time Long Start time of temporary increase. + end_time Long End time of temporary increase. + current_time Long Current time. + bandwidth Integer Current bandwidth, in Mbit/s. + next_expand_time Long Next increase time. + expand_count Integer Number of increases. + expand_effect_time Long Interval between temporary increases. + expand_interval_time Long Time to the next increase. + max_expand_count Integer Maximum number of increases. + task_running Boolean Whether the task is running. + ==================== ======= ===================================== + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id} + +Example Responses +----------------- + +**Status code: 200** + +The specified instance is queried successfully. + +.. code-block:: + + { + "publicip_id" : null, + "vpc_name" : "dcs-beta", + "charging_mode" : 0, + "enterprise_project_name" : "default", + "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", + "user_name" : "clouduser", + "created_at" : "2022-08-29T08:53:47.319Z", + "description" : null, + "security_group_id" : "securityGroupId", + "enable_ssl" : false, + "max_memory" : 128, + "publicip_address" : null, + "capacity" : 0, + "maintain_begin" : "18:00:00", + "engine" : "Redis", + "maintain_end" : "19:00:00", + "capacity_minor" : ".125", + "service_upgrade" : false, + "subnet_name" : "dcs-beta", + "no_password_access" : "true", + "service_task_id" : null, + "ip" : "192.168.0.251", + "subnet_cidr" : "192.168.0.0/24", + "used_memory" : 2, + "security_group_name" : "securityGroupId", + "instance_backup_policy" : null, + "az_codes" : [ "region01" ], + "access_user" : null, + "enterprise_project_id" : "0", + "instance_id" : "a4c545cd-10b2-4efc-b0ab-a9b554ca0621", + "enable_publicip" : false, + "port" : 6379, + "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", + "domain_name" : "redis-a4c545cd-10b2-4efc-b0ab-a9b554ca0621.dcs.xxx.com", + "name" : "dcs-billing", + "spec_code" : "redis.ha.xu1.tiny.r2.128", + "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af", + "engine_version" : "5.0", + "order_id" : null, + "status" : "RUNNING", + "features" : { + "support_acl" : true, + "support_transparent_client_ip" : true, + "support_ssl" : false + }, + "domain_name_info" : { + "support_public_resolve" : true, + "is_latest_rules" : true, + "zone_name" : "dcs.xxx.com", + "history_domain_names" : null + }, + "transparent_client_ip_enable" : true, + "sub_status" : "normal", + "tags" : null, + "cpu_type" : "x86_64" + } + +Status Codes +------------ + +=========== =============================================== +Status Code Description +=========== =============================================== +200 The specified instance is queried successfully. +400 Invalid request. +500 Internal service error. +=========== =============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/lifecycle_management/querying_all_dcs_instances.rst b/api-ref/source/api_v2/lifecycle_management/querying_all_dcs_instances.rst new file mode 100644 index 0000000..57409d7 --- /dev/null +++ b/api-ref/source/api_v2/lifecycle_management/querying_all_dcs_instances.rst @@ -0,0 +1,432 @@ +:original_name: ListInstances_0.html + +.. _ListInstances_0: + +Querying All DCS Instances +========================== + +Function +-------- + +This API is used to query DCS instances of a tenant, and allows you to specify query criteria. + +URI +--- + +GET /v2/{project_id}/instances + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================+ + | instance_id | No | String | Instance ID. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | include_failure | No | String | Whether to return the number of instances that fail to be created. If the value is **true**, the number of instances that failed to be created is returned. If the value is not **true**, the number is not returned. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | include_delete | No | String | Whether to return the number of instances that have been deleted. If the value is **true**, the number of instances that have been deleted is returned. If the value is not **true**, the number is not returned. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Instance name. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records displayed on each page. The minimum value is **1**. The maximum value is **1000**. If this parameter is not specified, 10 records are displayed on each page by default. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | String | Instance status For details, see "DCS Instance Statuses". | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name_equal | No | String | Whether to search for the instance that precisely matches a specified instance name. | + | | | | | + | | | | The default value is *false*, indicating that a fuzzy search is performed based on a specified instance name. If the value is **true**, the instance that precisely matches a specified instance name is queried. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | String | The query is 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 (,). | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip | No | String | IP address for connecting to the DCS instance. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity | No | String | DCS instance cache capacity in GB. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +--------------+---------------------------------------------------------------------------------------+-------------------------+ + | Parameter | Type | Description | + +==============+=======================================================================================+=========================+ + | instance_num | Integer | Number of instances. | + +--------------+---------------------------------------------------------------------------------------+-------------------------+ + | instances | Array of :ref:`InstanceListInfo ` objects | Instance details array. | + +--------------+---------------------------------------------------------------------------------------+-------------------------+ + +.. _listinstances_0__response_instancelistinfo: + +.. table:: **Table 4** InstanceListInfo + + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=============================================================================+==============================================================================================================================================================================+ + | publicip_id | String | ID of the EIP bound to the DCS Redis instance. The value of this parameter is **null** if public access is disabled. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_name | String | VPC name. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charging_mode | Integer | Billing mode. The value can be **0**: pay-per-use. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC ID. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Subnet ID. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Security group ID. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time. Format: 2017-03-31T12:24:46.297Z | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_ssl | Boolean | Whether to SSL is enabled for public access to a DCS Redis instance. | + | | | | + | | | - **true**: enable | + | | | | + | | | - **false**: disable | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_memory | Integer | Total memory size in MB. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | used_memory | Integer | Used memory size in MB. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | EIP bound to the DCS Redis instance. The value of this parameter is **null** if public access is disabled. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity | Integer | Cache capacity (GB) | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity_minor | String | Capacity (GB) of a small DCS instance (smaller than 1 GB). | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | order_id | String | Order ID. The value is null when a pay-per-use instance is created. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_begin | String | UTC time when the maintenance time window starts. The format is HH:mm:ss. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | maintain_end | String | UTC time when the maintenance time window ends. The format is HH:mm:ss. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine | String | Cache engine. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_version | String | Cache version. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_upgrade | Boolean | Whether the instance has an upgrade task. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | no_password_access | String | Indicates whether the instance can be accessed without a password. | + | | | | + | | | - **true**: The instance can be accessed without a password. | + | | | | + | | | - **false**: The instance can be accessed only after password authentication. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_task_id | String | Upgrade task ID. | + | | | | + | | | - If the value of **service_upgrade** is set to **true**, the value of this parameter is the ID of the upgrade task. | + | | | | + | | | - If the value of **service_upgrade** is set to **false**, the value of this parameter is empty. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip | String | IP address for connecting to the DCS instance. For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | access_user | String | Username used for accessing a DCS instance after password authentication. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_publicip | Boolean | Indicates whether public network access is enabled for the DCS Redis instance. | + | | | | + | | | - **true**: enable | + | | | | + | | | - **false**: disable | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | Integer | Port of the DCS instance. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | user_id | String | User ID. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | user_name | String | Username. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_name | String | Domain name of the instance. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | readonly_domain_name | String | Read-only domain name of the instance. This parameter is available only for master/standby instances. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Instance name. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | Product flavor. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Instance status For details, see "DCS Instance Statuses". | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`ResourceTag ` objects | Instance tag key and value. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description about the instance. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cpu_type | String | CPU type of the instance. Generally, the value is **x86_64** or **aarch64**. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_codes | Array of strings | AZs where there are available resources. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | features | :ref:`Features ` object | Features supported by the instance. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sub_status | String | Instance sub-status. | + +-----------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listinstances_0__response_resourcetag: + +.. table:: **Table 5** ResourceTag + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================================+ + | key | String | Tag key. | + | | | | + | | | - This field cannot be left blank. | + | | | | + | | | - The key value of a resource must be unique. | + | | | | + | | | - The tag key can contain a maximum of 36 characters. | + | | | | + | | | - The tag key must be unique and cannot be empty. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value. | + | | | | + | | | - This parameter is mandatory when **action** is set to **create** and is optional when **action** is set to **delete**. | + | | | | + | | | - The tag value can contain a maximum of 43 characters. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + +.. _listinstances_0__response_features: + +.. table:: **Table 6** Features + + +-------------------------------+-----------------------+--------------------------------------------+ + | Parameter | Type | Description | + +===============================+=======================+============================================+ + | support_acl | Boolean | Whether ACL is supported. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-------------------------------+-----------------------+--------------------------------------------+ + | support_transparent_client_ip | Boolean | Whether client IP pass-through is enabled. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-------------------------------+-----------------------+--------------------------------------------+ + | support_ssl | Boolean | Whether SSL is supported. | + | | | | + | | | - **true**: yes | + | | | | + | | | - **false**: no | + +-------------------------------+-----------------------+--------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances?offset=0&limit=10&name={name}&status={status}&id={id}&include_failure=true&include_delete=true&name_equal=false + +Example Responses +----------------- + +**Status code: 200** + +All instances are listed successfully. + +.. code-block:: + + { + "instance_num" : 1, + "instances" : [ { + "publicip_id" : { }, + "vpc_name" : "dcs-beta", + "charging_mode" : 0, + "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481", + "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af", + "user_name" : "clouduser", + "created_at" : "2022-08-29T09:00:34.335Z", + "enable_ssl" : false, + "max_memory" : 128, + "publicip_address" : null, + "capacity" : 0, + "order_id" : null, + "maintain_begin" : "18:00:00", + "engine" : "Redis", + "maintain_end" : "19:00:00", + "capacity_minor" : ".125", + "service_upgrade" : false, + "no_password_access" : true, + "service_task_id" : "", + "ip" : "192.168.0.195", + "used_memory" : 2, + "access_user" : null, + "instance_id" : "c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5", + "enable_publicip" : false, + "port" : 6379, + "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7", + "domain_name" : "redis-c830053e-d5a3-4bc0-b6d6-ca37d1ea9dd5.dcs.xxx.com", + "name" : "dcs-lpvo0829", + "spec_code" : "redis.ha.xu1.tiny.r2.128", + "engine_version" : "5.0", + "status" : "RUNNING", + "security_group_id" : "securityGroupId", + "enterprise_project_id" : 0, + "tags" : [ { + "key" : 1, + "value" : "DCS" + } ], + "az_codes" : [ "region01", "region02" ], + "description" : "Instance description.", + "cpu_type" : "x86_64", + "features" : { + "support_acl" : true, + "support_transparent_client_ip" : true, + "support_ssl" : false + }, + "sub_status" : "normal" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4800", + "error_msg" : "Invalid offset in the request." + } + +Status Codes +------------ + +=========== ====================================== +Status Code Description +=========== ====================================== +200 All instances are listed successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ====================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/log_management/collecting_redis_run_logs.rst b/api-ref/source/api_v2/log_management/collecting_redis_run_logs.rst new file mode 100644 index 0000000..02938e4 --- /dev/null +++ b/api-ref/source/api_v2/log_management/collecting_redis_run_logs.rst @@ -0,0 +1,185 @@ +:original_name: CreateRedislog_1.html + +.. _CreateRedislog_1: + +Collecting Redis Run Logs +========================= + +Function +-------- + +This API is used to collect Redis run logs. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/redislog + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +----------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+=========+========================================================================================================================================================================================================================================================================+ + | query_time | No | Integer | Date offset, indicating that the query starts from the last n days. For example, the value **0** indicates that the logs of the current day are queried, and the value **7** indicates that the logs of the last seven days are queried. The value ranges from 0 to 7. | + +----------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_type | Yes | String | Log type. Currently, only Redis run logs are supported. The value is **run**. | + +----------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | replication_id | No | String | Replica ID. You can query the replica ID from **Shards and Replicas**. This parameter is mandatory when the instance is not single-node. | + +----------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/redislog?log_type=run&query_time=7 + +Example Responses +----------------- + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4800", + "error_msg" : "Invalid logType." + } + +Status Codes +------------ + +=========== ==================================== +Status Code Description +=========== ==================================== +204 Run logs collected successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ==================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/log_management/index.rst b/api-ref/source/api_v2/log_management/index.rst new file mode 100644 index 0000000..711dc6a --- /dev/null +++ b/api-ref/source/api_v2/log_management/index.rst @@ -0,0 +1,20 @@ +:original_name: LogManagement_0.html + +.. _LogManagement_0: + +Log Management +============== + +- :ref:`Querying the Slow Log ` +- :ref:`Listing Redis Run Logs ` +- :ref:`Collecting Redis Run Logs ` +- :ref:`Obtaining the Log Download Link ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_the_slow_log + listing_redis_run_logs + collecting_redis_run_logs + obtaining_the_log_download_link diff --git a/api-ref/source/api_v2/log_management/listing_redis_run_logs.rst b/api-ref/source/api_v2/log_management/listing_redis_run_logs.rst new file mode 100644 index 0000000..bc5bbcb --- /dev/null +++ b/api-ref/source/api_v2/log_management/listing_redis_run_logs.rst @@ -0,0 +1,238 @@ +:original_name: ListRedislog_1.html + +.. _ListRedislog_1: + +Listing Redis Run Logs +====================== + +Function +-------- + +This API is used to query the Redis run logs. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/redislog + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+=====================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + | log_type | Yes | String | Log type. Currently, only Redis run logs are supported. The value is **run**. | + +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+--------------------------------------------------------------------------+---------------+ + | Parameter | Type | Description | + +===========+==========================================================================+===============+ + | total_num | Integer | Total. | + +-----------+--------------------------------------------------------------------------+---------------+ + | file_list | Array of :ref:`RunlogItem ` objects | Run log list. | + +-----------+--------------------------------------------------------------------------+---------------+ + +.. _listredislog_1__response_runlogitem: + +.. table:: **Table 4** RunlogItem + + +----------------+--------+-------------------------------------------------------------+ + | Parameter | Type | Description | + +================+========+=============================================================+ + | id | String | Unique ID of a run log. | + +----------------+--------+-------------------------------------------------------------+ + | file_name | String | Run log file name. | + +----------------+--------+-------------------------------------------------------------+ + | group_name | String | Shard name. | + +----------------+--------+-------------------------------------------------------------+ + | replication_ip | String | IP address of the replica where the run logs are collected. | + +----------------+--------+-------------------------------------------------------------+ + | status | String | Run log status. | + +----------------+--------+-------------------------------------------------------------+ + | time | String | Date when run logs are collected. The format is yyyy-MM-dd. | + +----------------+--------+-------------------------------------------------------------+ + | backup_id | String | Log file ID. | + +----------------+--------+-------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/redislog?log_type=run&offset=1&limit=10 + +Example Responses +----------------- + +**Status code: 200** + +Run logs queried successfully. + +.. code-block:: + + { + "total_num" : 1, + "file_list" : [ { + "id" : "e79f2d97-e972-41f2-b51c-d18f65f39a45", + "file_name" : "redis_192.168.0.142_2021-04-16.log", + "status" : "succeed", + "time" : "2021-04-16", + "replication_ip" : "192.168.0.142", + "group_name" : "group-0", + "backup_id" : "e79f2d97-e972-41f2-b51c-d18f65f39a45" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4800", + "error_msg" : "Invalid logType." + } + +Status Codes +------------ + +=========== ==================================== +Status Code Description +=========== ==================================== +200 Run logs queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ==================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/log_management/obtaining_the_log_download_link.rst b/api-ref/source/api_v2/log_management/obtaining_the_log_download_link.rst new file mode 100644 index 0000000..2716e45 --- /dev/null +++ b/api-ref/source/api_v2/log_management/obtaining_the_log_download_link.rst @@ -0,0 +1,188 @@ +:original_name: CreateRedislogDownloadLink_1.html + +.. _CreateRedislogDownloadLink_1: + +Obtaining the Log Download Link +=============================== + +Function +-------- + +This API is used to obtain the link for downloading logs. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/redislog/{id}/links + +.. table:: **Table 1** Path Parameters + + +-------------+-----------+--------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+============================================================================+ + | project_id | Yes | String | Project ID. | + +-------------+-----------+--------+----------------------------------------------------------------------------+ + | instance_id | Yes | String | Instance ID. | + +-------------+-----------+--------+----------------------------------------------------------------------------+ + | id | Yes | String | Unique ID of a log, which is obtained from the API used to query run logs. | + +-------------+-----------+--------+----------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------+--------+-------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=============================================================+ + | id | String | Log ID. | + +-----------+--------+-------------------------------------------------------------+ + | link | String | Log download link. The default validity period is 24 hours. | + +-----------+--------+-------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/0524e839a54847039e9b2b46e8aa788a/instances/5c597ce5-9823-48aa-bf4d-2defb9385b4a/redislog/3ea6ce21-048e-447a-83c3-3fb004b88439/links + +Example Responses +----------------- + +**Status code: 200** + +Log download link obtained successfully. + +.. code-block:: + + { + "backup_id" : "3ea6ce21-048e-447a-83c3-3fb004b88439", + "link" : "https://bucketxxxxx.{obs_endpoint}:443/xxxxx/redis_192.168.x.x_2021-04-16.log?AWSAccessKeyId=xxxxx" + } + +Status Codes +------------ + +=========== ======================================== +Status Code Description +=========== ======================================== +200 Log download link obtained successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ======================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/log_management/querying_the_slow_log.rst b/api-ref/source/api_v2/log_management/querying_the_slow_log.rst new file mode 100644 index 0000000..def3fd7 --- /dev/null +++ b/api-ref/source/api_v2/log_management/querying_the_slow_log.rst @@ -0,0 +1,250 @@ +:original_name: ListSlowlog_1.html + +.. _ListSlowlog_1: + +Querying the Slow Log +===================== + +Function +-------- + +This API is used to query slow logs. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/slowlog + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=============================================================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | String | Keyword based on which the return results are sorted. The value can be **start_time** or **duration**. The default value is **start_time**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **start_time** | + | | | | | + | | | | - **duration** | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | String | Result sorting order. The value can be **desc** (descending order) or **asc** (ascending order). The default value is **desc**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **desc** | + | | | | | + | | | | - **asc** | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | start_time | Yes | String | Query start time (UTC). Example: **1598803200000**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | Yes | String | Query end time (UTC). Example: 1599494399000. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+---------------------------------------------------------------------------+----------------+ + | Parameter | Type | Description | + +===========+===========================================================================+================+ + | count | Integer | Total. | + +-----------+---------------------------------------------------------------------------+----------------+ + | slowlogs | Array of :ref:`SlowlogItem ` objects | Slow log list. | + +-----------+---------------------------------------------------------------------------+----------------+ + +.. _listslowlog_1__response_slowlogitem: + +.. table:: **Table 4** SlowlogItem + + +------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+=========+===========================================================================================================================+ + | id | Integer | Unique ID of a slow log. | + +------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + | command | String | Slow command. | + +------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + | start_time | String | Execution start time. Example: **2020-06-19T07:06:07Z**. | + +------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + | duration | String | Duration, in milliseconds. | + +------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + | shard_name | String | Name of the shard where the slow command is executed. This parameter is supported only when the instance type is cluster. | + +------------+---------+---------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/slowlog?start_time=1598803200000&end_time=1599494399000 + +Example Responses +----------------- + +**Status code: 200** + +Slow logs queried successfully. + +.. code-block:: + + { + "count" : 1, + "slowlogs" : [ { + "id" : 1, + "start_time" : "2020-06-19T07:06:07Z", + "command" : "SLOWLOG GET 128", + "duration" : "17", + "shard_name" : "group-0" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4800", + "error_msg" : "Invalid start_time in the request." + } + +Status Codes +------------ + +=========== ==================================== +Status Code Description +=========== ==================================== +200 Slow logs queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ==================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/network_security/configuring_ip_whitelist_groups.rst b/api-ref/source/api_v2/network_security/configuring_ip_whitelist_groups.rst similarity index 71% rename from api-ref/source/network_security/configuring_ip_whitelist_groups.rst rename to api-ref/source/api_v2/network_security/configuring_ip_whitelist_groups.rst index 9c20cf6..83a37d8 100644 --- a/api-ref/source/network_security/configuring_ip_whitelist_groups.rst +++ b/api-ref/source/api_v2/network_security/configuring_ip_whitelist_groups.rst @@ -1,25 +1,21 @@ -:original_name: UpdateIpWhitelist.html +:original_name: UpdateIpWhitelist_1.html -.. _UpdateIpWhitelist: +.. _UpdateIpWhitelist_1: Configuring IP Whitelist Groups =============================== -.. note:: - - IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instances - Function -------- -This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one. +This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one. IP whitelist groups are supported only by DCS Redis 4.0/5.0/6.0 instances, and not by DCS Redis 3.0 instances. URI --- PUT /v2/{project_id}/instance/{instance_id}/whitelist -.. table:: **Table 1** Path parameter +.. table:: **Table 1** Path Parameters =========== ========= ====== ============ Parameter Mandatory Type Description @@ -33,20 +29,23 @@ Request Parameters .. table:: **Table 2** Request body parameters - +------------------+-----------------+--------------------------------------------------------------------------+----------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+==========================================================================+==================================+ - | enable_whitelist | Yes | Boolean | Whether to enable the whitelist. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **true** | - | | | | - **false** | - +------------------+-----------------+--------------------------------------------------------------------------+----------------------------------+ - | whitelist | Yes | Array of :ref:`Whitelist ` objects | IP whitelist group. | - +------------------+-----------------+--------------------------------------------------------------------------+----------------------------------+ + +------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+=================+============================================================================+==========================================================================+ + | instance_id | No | String | Instance ID. | + +------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | enable_whitelist | Yes | Boolean | Whether to enable the whitelist. The options are **true** and **false**. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **true** | + | | | | | + | | | | - **false** | + +------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | whitelist | Yes | Array of :ref:`Whitelist ` objects | IP whitelist group. | + +------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------+ -.. _updateipwhitelist__request_whitelist: +.. _updateipwhitelist_1__request_whitelist: .. table:: **Table 3** Whitelist @@ -68,17 +67,17 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+======================================================================================+ - | error_msg | String | Error information. | + | error_msg | String | Error message. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_code | String | Error code. | | | | | - | | | Maximum length: 9 characters | + | | | Maximum: **9** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ **Status code: 401** @@ -88,17 +87,17 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+======================================================================================+ - | error_msg | String | Error information. | + | error_msg | String | Error message. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_code | String | Error code. | | | | | - | | | Maximum length: 9 characters | + | | | Maximum: **9** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ **Status code: 403** @@ -108,17 +107,17 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+======================================================================================+ - | error_msg | String | Error information. | + | error_msg | String | Error message. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_code | String | Error code. | | | | | - | | | Maximum length: 9 characters | + | | | Maximum: **9** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ **Status code: 404** @@ -128,17 +127,17 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+======================================================================================+ - | error_msg | String | Error information. | + | error_msg | String | Error message. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_code | String | Error code. | | | | | - | | | Maximum length: 9 characters | + | | | Maximum: **9** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ **Status code: 500** @@ -148,21 +147,21 @@ Response Parameters +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+======================================================================================+ - | error_msg | String | Error information. | + | error_msg | String | Error message. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_code | String | Error code. | | | | | - | | | Maximum length: 9 characters | + | | | Maximum: **9** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | | | | | - | | | Maximum length: 1024 characters | + | | | Maximum: **1024** | +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ -Example Request ---------------- +Example Requests +---------------- .. code-block:: text @@ -176,8 +175,8 @@ Example Request } ] } -Example Response ----------------- +Example Responses +----------------- None @@ -191,11 +190,11 @@ Status Code Description 400 Invalid request. 401 Invalid authentication information. 403 The request is rejected. -404 The requested resource could not be found. -500 Internal service error +404 The requested resource is not found. +500 Internal service error. =========== ============================================ Error Codes ----------- -See :ref:`Error Codes `. +See :ref:`Error Codes `. diff --git a/api-ref/source/network_security/index.rst b/api-ref/source/api_v2/network_security/index.rst similarity index 59% rename from api-ref/source/network_security/index.rst rename to api-ref/source/api_v2/network_security/index.rst index 3d1e429..9445e2c 100644 --- a/api-ref/source/network_security/index.rst +++ b/api-ref/source/api_v2/network_security/index.rst @@ -1,12 +1,12 @@ -:original_name: topic_300000009.html +:original_name: NetworkSecurityManagement_0.html -.. _topic_300000009: +.. _NetworkSecurityManagement_0: Network Security ================ -- :ref:`Configuring IP Whitelist Groups ` -- :ref:`Querying the IP Whitelist of a DCS Instance ` +- :ref:`Configuring IP Whitelist Groups ` +- :ref:`Querying the IP Whitelist of a DCS Instance ` .. toctree:: :maxdepth: 1 diff --git a/api-ref/source/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst b/api-ref/source/api_v2/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst similarity index 66% rename from api-ref/source/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst rename to api-ref/source/api_v2/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst index 292c075..bbdf507 100644 --- a/api-ref/source/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst +++ b/api-ref/source/api_v2/network_security/querying_the_ip_whitelist_of_a_dcs_instance.rst @@ -1,6 +1,6 @@ -:original_name: ShowIpWhitelist.html +:original_name: ShowIpWhitelist_1.html -.. _ShowIpWhitelist: +.. _ShowIpWhitelist_1: Querying the IP Whitelist of a DCS Instance =========================================== @@ -15,7 +15,7 @@ URI GET /v2/{project_id}/instance/{instance_id}/whitelist -.. table:: **Table 1** Path parameter +.. table:: **Table 1** Path Parameters =========== ========= ====== ============ Parameter Mandatory Type Description @@ -36,20 +36,23 @@ Response Parameters .. table:: **Table 2** Response body parameters - +-----------------------+-------------------------------------------------------------------------+----------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================+==================================+ - | enable_whitelist | Boolean | Whether to enable the whitelist. | - | | | | - | | | Options: | - | | | | - | | | - **true** | - | | | - **false** | - +-----------------------+-------------------------------------------------------------------------+----------------------------------+ - | whitelist | Array of :ref:`Whitelist ` objects | IP whitelist group. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------+ + +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===========================================================================+==========================================================================+ + | instance_id | String | Instance ID. | + +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | enable_whitelist | Boolean | Whether to enable the whitelist. The options are **true** and **false**. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **true** | + | | | | + | | | - **false** | + +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------+ + | whitelist | Array of :ref:`Whitelist ` objects | IP whitelist group. | + +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------+ -.. _showipwhitelist__response_whitelist: +.. _showipwhitelist_1__response_whitelist: .. table:: **Table 3** Whitelist @@ -61,15 +64,15 @@ Response Parameters | ip_list | Array of strings | List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported. | +------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example Request ---------------- +Example Requests +---------------- .. code-block:: text GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist -Example Response ----------------- +Example Responses +----------------- **Status code: 200** @@ -98,4 +101,4 @@ Status Code Description Error Codes ----------- -See :ref:`Error Codes `. +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/other_apis/index.rst b/api-ref/source/api_v2/other_apis/index.rst new file mode 100644 index 0000000..69f0d8c --- /dev/null +++ b/api-ref/source/api_v2/other_apis/index.rst @@ -0,0 +1,24 @@ +:original_name: OtherInterface_0.html + +.. _OtherInterface_0: + +Other APIs +========== + +- :ref:`Querying Product Flavors ` +- :ref:`Listing Maintenance Time Windows ` +- :ref:`Querying the Tenant Quotas ` +- :ref:`Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension ` +- :ref:`Listing Monitored Objects on Primary Dimensions ` +- :ref:`Querying AZs ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_product_flavors + listing_maintenance_time_windows + querying_the_tenant_quotas + listing_monitored_objects_on_secondary_dimensions_under_a_primary_dimension + listing_monitored_objects_on_primary_dimensions + querying_azs diff --git a/api-ref/source/api_v2/other_apis/listing_maintenance_time_windows.rst b/api-ref/source/api_v2/other_apis/listing_maintenance_time_windows.rst new file mode 100644 index 0000000..05c1d7d --- /dev/null +++ b/api-ref/source/api_v2/other_apis/listing_maintenance_time_windows.rst @@ -0,0 +1,225 @@ +:original_name: ListMaintenanceWindows_0.html + +.. _ListMaintenanceWindows_0: + +Listing Maintenance Time Windows +================================ + +Function +-------- + +This API is used to query the start time and end time of maintenance windows. + +URI +--- + +GET /v2/instances/maintain-windows + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 1** Response body parameters + + +------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------+ + | Parameter | Type | Description | + +==================+==========================================================================================================+=============================================+ + | maintain_windows | Array of :ref:`MaintainWindowsEntity ` objects | List of supported maintenance time windows. | + +------------------+----------------------------------------------------------------------------------------------------------+---------------------------------------------+ + +.. _listmaintenancewindows_0__response_maintainwindowsentity: + +.. table:: **Table 2** MaintainWindowsEntity + + +-----------+---------+---------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========+===========================================================================+ + | seq | Integer | Sequence number of the maintenance time window. | + +-----------+---------+---------------------------------------------------------------------------+ + | default | Boolean | Whether a maintenance time window is set to the default time segment. | + +-----------+---------+---------------------------------------------------------------------------+ + | begin | String | UTC time when the maintenance time window starts. The format is HH:mm:ss. | + +-----------+---------+---------------------------------------------------------------------------+ + | end | String | UTC time when the maintenance time window ends. The format is HH:mm:ss. | + +-----------+---------+---------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/instances/maintain-windows + +Example Responses +----------------- + +**Status code: 200** + +Maintenance time windows queried successfully. + +.. code-block:: + + { + "maintain_windows" : [ { + "default" : true, + "end" : "19", + "begin" : "18", + "seq" : 1 + }, { + "default" : false, + "end" : "20", + "begin" : "19", + "seq" : 2 + }, { + "default" : false, + "end" : "21", + "begin" : "20", + "seq" : 3 + }, { + "default" : false, + "end" : "22", + "begin" : "21", + "seq" : 4 + }, { + "default" : false, + "end" : "23", + "begin" : "22", + "seq" : 5 + }, { + "default" : false, + "end" : "00", + "begin" : "23", + "seq" : 6 + }, { + "default" : false, + "end" : "01", + "begin" : "00", + "seq" : 1 + }, { + "default" : false, + "end" : "02", + "begin" : "01", + "seq" : 2 + }, { + "default" : false, + "end" : "03", + "begin" : "02", + "seq" : 3 + }, { + "default" : false, + "end" : "04", + "begin" : "03", + "seq" : 3 + }, { + "default" : false, + "end" : "05", + "begin" : "04", + "seq" : 4 + }, { + "default" : false, + "end" : "06", + "begin" : "05", + "seq" : 5 + }, { + "default" : false, + "end" : "07", + "begin" : "06", + "seq" : 6 + }, { + "default" : false, + "end" : "08", + "begin" : "07", + "seq" : 1 + }, { + "default" : true, + "end" : "09", + "begin" : "08", + "seq" : 2 + }, { + "default" : false, + "end" : "10", + "begin" : "09", + "seq" : 3 + }, { + "default" : false, + "end" : "11", + "begin" : "10", + "seq" : 4 + }, { + "default" : false, + "end" : "12", + "begin" : "11", + "seq" : 5 + }, { + "default" : false, + "end" : "13", + "begin" : "12", + "seq" : 6 + }, { + "default" : false, + "end" : "14", + "begin" : "13", + "seq" : 1 + }, { + "default" : true, + "end" : "15", + "begin" : "14", + "seq" : 2 + }, { + "default" : false, + "end" : "16", + "begin" : "15", + "seq" : 3 + }, { + "default" : false, + "end" : "17", + "begin" : "16", + "seq" : 4 + }, { + "default" : false, + "end" : "18", + "begin" : "17", + "seq" : 5 + } ] + } + +Status Codes +------------ + +=========== ============================================== +Status Code Description +=========== ============================================== +200 Maintenance time windows queried successfully. +500 Internal service error. +=========== ============================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/other_apis/listing_monitored_objects_on_primary_dimensions.rst b/api-ref/source/api_v2/other_apis/listing_monitored_objects_on_primary_dimensions.rst new file mode 100644 index 0000000..d841208 --- /dev/null +++ b/api-ref/source/api_v2/other_apis/listing_monitored_objects_on_primary_dimensions.rst @@ -0,0 +1,171 @@ +:original_name: ListMonitoredObjects_0.html + +.. _ListMonitoredObjects_0: + +Listing Monitored Objects on Primary Dimensions +=============================================== + +Function +-------- + +This API is used to query the monitored objects on primary dimensions **dcs_instance_id**. + +URI +--- + +GET /v2/{project_id}/dims/monitored-objects + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Tenant ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================+ + | dim_name | Yes | String | Primary dimension ID, which can be **dcs_instance_id**. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + | | | | | + | | | | Default: **0** | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. | + | | | | | + | | | | Default: **10** | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================================================+==================================================================================================================================+ + | router | Array of strings | Route of the specified dimension. If the dimension is the primary dimension, the array contains the ID of the primary dimension. | + +-----------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | children | Array of :ref:`DimChild ` objects | Secondary dimensions under the specified dimension. This parameter is valid only when the dimension is **dcs_instance_id**. | + | | | | + | | | - The secondary dimension of a Proxy Cluster instance can be **dcs_cluster_redis_node** or **dcs_cluster_proxy_node**. | + | | | | + | | | - The secondary dimension of a Redis Cluster instance can be **dcs_cluster_proxy_node**. | + +-----------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`InstancesMonitoredObject ` objects | Monitored objects of the specified dimension. | + +-----------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of monitored objects on the primary dimension. | + +-----------------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +.. _listmonitoredobjects_0__response_dimchild: + +.. table:: **Table 4** DimChild + + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=====================================================================================================================================================================================================+ + | dim_name | String | Dimension name. Currently, the following dimensions are supported: **dcs_instance_id**, **dcs_cluster_redis_node**, **dcs_cluster_proxy_node**. | + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dim_route | String | Dimension route. Format: *Dimension name,Sub-dimension name*. For example, if **dim_name** is **dcs_cluster_redis_node**, the value of **dim_route** is **dcs_instance_id,dcs_cluster_redis_node**. | + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listmonitoredobjects_0__response_instancesmonitoredobject: + +.. table:: **Table 5** InstancesMonitoredObject + + +-----------------+--------+---------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+===============================================================+ + | dcs_instance_id | String | ID of the monitored object, which is the instance ID. | + +-----------------+--------+---------------------------------------------------------------+ + | name | String | Name of the monitored object, which is the instance name. | + +-----------------+--------+---------------------------------------------------------------+ + | status | String | Status of the monitored object, which is the instance status. | + +-----------------+--------+---------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}}/v2/{project_id}}/dims/monitored-objects?dim_name={dim_name} + +Example Responses +----------------- + +**Status code: 200** + +Successfully listed the monitored objects on the primary dimension. + +.. code-block:: + + { + "router" : [ "dcs_instance_id" ], + "total" : 3, + "children" : [ { + "dim_name" : "dcs_cluster_redis_node", + "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" + }, { + "dim_name" : "dcs_cluster_proxy_node", + "dim_route" : "dcs_instance_id,dcs_cluster_proxy_node" + } ], + "instances" : [ { + "name" : "dcs-redis-single-node", + "status" : "RUNNING", + "dcs_instance_id" : "fe909c47-8990-44a0-9154-d0a1e95e78fe" + }, { + "name" : "dcs-redis-master-standby", + "status" : "RUNNING", + "dcs_instance_id" : "877e5ae3-482e-4c38-88a0-030a0fa6f399" + }, { + "name" : "dcs-proxy-cluster", + "status" : "RUNNING", + "dcs_instance_id" : "448ee851-1366-47f2-913a-e21032e690c4" + } ] + } + +Status Codes +------------ + ++-------------+---------------------------------------------------------------------+ +| Status Code | Description | ++=============+=====================================================================+ +| 200 | Successfully listed the monitored objects on the primary dimension. | ++-------------+---------------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+---------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/other_apis/listing_monitored_objects_on_secondary_dimensions_under_a_primary_dimension.rst b/api-ref/source/api_v2/other_apis/listing_monitored_objects_on_secondary_dimensions_under_a_primary_dimension.rst new file mode 100644 index 0000000..eb3f687 --- /dev/null +++ b/api-ref/source/api_v2/other_apis/listing_monitored_objects_on_secondary_dimensions_under_a_primary_dimension.rst @@ -0,0 +1,239 @@ +:original_name: ListMonitoredObjectsOfInstance_0.html + +.. _ListMonitoredObjectsOfInstance_0: + +Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension +=========================================================================== + +Function +-------- + +This API is used to query the monitored objects on secondary dimensions under primary dimension **dcs_instance_id**. + +URI +--- + +GET /v2/{project_id}/dims/monitored-objects/{instance_id} + +.. table:: **Table 1** Path Parameters + + +-------------+-----------+--------+--------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+================================================================================+ + | project_id | Yes | String | Tenant ID. | + +-------------+-----------+--------+--------------------------------------------------------------------------------+ + | instance_id | Yes | String | ID of the monitored object on the primary dimension, which is the instance ID. | + +-------------+-----------+--------+--------------------------------------------------------------------------------+ + +.. table:: **Table 2** Query Parameters + + +-----------+-----------+--------+----------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+========+================================================================+ + | dim_name | Yes | String | ID of the primary dimension, which can be **dcs_instance_id**. | + +-----------+-----------+--------+----------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+======================================================================================================================================+=====================================================================================================================================================================================================+ + | router | Array of strings | Route of the specified dimension. If the dimension is the primary dimension, the array contains the ID of the primary dimension. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | children | Array of :ref:`DimChild ` objects | Secondary dimensions under the specified dimension. This parameter is valid only when the dimension is **dcs_instance_id**. | + | | | | + | | | - The secondary dimension of a Proxy Cluster instance can be **dcs_cluster_redis_node** or **dcs_cluster_proxy_node**. | + | | | | + | | | - The secondary dimension of a Redis Cluster instance can be **dcs_cluster_proxy_node**. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instances | Array of :ref:`InstancesMonitoredObject ` objects | Monitored objects of the specified dimension. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dcs_cluster_redis_node | Array of :ref:`ClusterRedisNodeMonitoredObject ` objects | Monitored objects of the Redis Server. This parameter is valid for Proxy Cluster and Redis Cluster instances. The field name is the same as the secondary dimension object name under **children**. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dcs_cluster_proxy_node | Array of :ref:`ProxyNodeMonitoredObject ` objects | Monitored objects of the Proxy. This parameter is valid only for Redis 3.0 Proxy Cluster instances. The field name is the same as the secondary dimension object name under **children**. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dcs_cluster_proxy2_node | Array of :ref:`Proxy2NodeMonitoredObject ` objects | Monitored objects of the Proxy. This parameter is valid only for Redis 4.0 and 5.0 Proxy Cluster instances. The field name is the same as the secondary dimension object name under **children**. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of monitored objects on the primary dimension. | + +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listmonitoredobjectsofinstance_0__response_dimchild: + +.. table:: **Table 4** DimChild + + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+=====================================================================================================================================================================================================+ + | dim_name | String | Dimension name. Currently, the following dimensions are supported: **dcs_instance_id**, **dcs_cluster_redis_node**, **dcs_cluster_proxy_node**. | + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dim_route | String | Dimension route. Format: *Dimension name,Sub-dimension name*. For example, if **dim_name** is **dcs_cluster_redis_node**, the value of **dim_route** is **dcs_instance_id,dcs_cluster_redis_node**. | + +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listmonitoredobjectsofinstance_0__response_instancesmonitoredobject: + +.. table:: **Table 5** InstancesMonitoredObject + + +-----------------+--------+---------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+===============================================================+ + | dcs_instance_id | String | ID of the monitored object, which is the instance ID. | + +-----------------+--------+---------------------------------------------------------------+ + | name | String | Name of the monitored object, which is the instance name. | + +-----------------+--------+---------------------------------------------------------------+ + | status | String | Status of the monitored object, which is the instance status. | + +-----------------+--------+---------------------------------------------------------------+ + +.. _listmonitoredobjectsofinstance_0__response_clusterredisnodemonitoredobject: + +.. table:: **Table 6** ClusterRedisNodeMonitoredObject + + +------------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+========+=========================================================================+ + | dcs_instance_id | String | ID of the monitored object, which is the node ID. | + +------------------------+--------+-------------------------------------------------------------------------+ + | name | String | Name of the monitored object, which is the node IP address. | + +------------------------+--------+-------------------------------------------------------------------------+ + | dcs_cluster_redis_node | String | ID of the monitored object on the **dcs_cluster_redis_node** dimension. | + +------------------------+--------+-------------------------------------------------------------------------+ + | status | String | Status of the monitored object, which is the node status. | + +------------------------+--------+-------------------------------------------------------------------------+ + +.. _listmonitoredobjectsofinstance_0__response_proxynodemonitoredobject: + +.. table:: **Table 7** ProxyNodeMonitoredObject + + +------------------------+--------+-------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+========+=========================================================================+ + | dcs_instance_id | String | ID of the monitored object, which is the node ID. | + +------------------------+--------+-------------------------------------------------------------------------+ + | name | String | Name of the monitored object, which is the node IP address. | + +------------------------+--------+-------------------------------------------------------------------------+ + | dcs_cluster_proxy_node | String | ID of the monitored object on the **dcs_cluster_proxy_node** dimension. | + +------------------------+--------+-------------------------------------------------------------------------+ + | status | String | Status of the monitored object, which is the node status. | + +------------------------+--------+-------------------------------------------------------------------------+ + +.. _listmonitoredobjectsofinstance_0__response_proxy2nodemonitoredobject: + +.. table:: **Table 8** Proxy2NodeMonitoredObject + + +-------------------------+--------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+========+==========================================================================+ + | dcs_instance_id | String | ID of the monitored object, which is the node ID. | + +-------------------------+--------+--------------------------------------------------------------------------+ + | name | String | Name of the monitored object, which is the node IP address. | + +-------------------------+--------+--------------------------------------------------------------------------+ + | dcs_cluster_proxy2_node | String | ID of the monitored object on the **dcs_cluster_proxy2_node** dimension. | + +-------------------------+--------+--------------------------------------------------------------------------+ + | status | String | Status of the monitored object, which is the node status. | + +-------------------------+--------+--------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/dims/monitored-objects/{instance_id}?dim_name={dim_name} + +Example Responses +----------------- + +**Status code: 200** + +Successfully queried the monitored objects on the primary dimension. + +.. code-block:: + + { + "router" : [ "dcs_instance_id" ], + "total" : 1, + "children" : [ { + "dim_name" : "dcs_cluster_redis_node", + "dim_route" : "dcs_instance_id,dcs_cluster_redis_node" + } ], + "instances" : [ { + "name" : "dcs-test001", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19" + } ], + "dcs_cluster_redis_node" : [ { + "name" : "(master)192.168.2.145", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", + "dcs_cluster_redis_node" : "b1f4aa9e4dae50888e58c9caecdfc108" + }, { + "name" : "(replica)192.168.2.199", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", + "dcs_cluster_redis_node" : "e0e10e489a73487147928167396474bc" + }, { + "name" : "(master)192.168.2.243", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", + "dcs_cluster_redis_node" : "e797c3ba8bee782e25cdd4a90eb00517" + }, { + "name" : "(replica)192.168.2.164", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", + "dcs_cluster_redis_node" : "d810fb44f9f7a359e000cf277a824c43" + }, { + "name" : "(master)192.168.2.95", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", + "dcs_cluster_redis_node" : "f25c37a4654d50b07e629fc2adfba60f" + }, { + "name" : "(replica)192.168.2.51", + "status" : "RUNNING", + "dcs_instance_id" : "03ca9da0-1104-40a5-b49d-5ef8e41bfd19", + "dcs_cluster_redis_node" : "da5149a20dc7caf35587e4d2433fe452" + } ] + } + +Status Codes +------------ + ++-------------+----------------------------------------------------------------------+ +| Status Code | Description | ++=============+======================================================================+ +| 200 | Successfully queried the monitored objects on the primary dimension. | ++-------------+----------------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+----------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/other_apis/querying_azs.rst b/api-ref/source/api_v2/other_apis/querying_azs.rst new file mode 100644 index 0000000..085deaa --- /dev/null +++ b/api-ref/source/api_v2/other_apis/querying_azs.rst @@ -0,0 +1,117 @@ +:original_name: ListAvailableZones_0.html + +.. _ListAvailableZones_0: + +Querying AZs +============ + +Function +-------- + +This API is used to query the AZ information of the current region. + +URI +--- + +GET /v2/available-zones + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 1** Response body parameters + + +-----------------+----------------------------------------------------------------------------------------+---------------+ + | Parameter | Type | Description | + +=================+========================================================================================+===============+ + | region_id | String | Region ID. | + +-----------------+----------------------------------------------------------------------------------------+---------------+ + | available_zones | Array of :ref:`AvailableZones ` objects | Array of AZs. | + +-----------------+----------------------------------------------------------------------------------------+---------------+ + +.. _listavailablezones_0__response_availablezones: + +.. table:: **Table 2** AvailableZones + + +-----------------------+-----------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================+ + | code | String | AZ code. | + +-----------------------+-----------------------+-------------------------------------------------------+ + | port | String | AZ port. | + +-----------------------+-----------------------+-------------------------------------------------------+ + | name | String | AZ name. | + +-----------------------+-----------------------+-------------------------------------------------------+ + | id | String | AZ ID. | + +-----------------------+-----------------------+-------------------------------------------------------+ + | resource_availability | String | Whether the AZ has available resources. | + | | | | + | | | - **true**: There are available resources in the AZ. | + | | | | + | | | - **false**: No resource is available | + | | | | + | | | Enumeration values: | + | | | | + | | | - **true** | + | | | | + | | | - **false** | + +-----------------------+-----------------------+-------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/available-zones + +Example Responses +----------------- + +**Status code: 200** + +The query is successful. + +.. code-block:: + + { + "region_id" : "region00", + "available_zones" : [ { + "code" : "region01", + "port" : "8403", + "name" : "AZ 1.", + "id" : "effdcbc7d4d64a02aa1fa26b42f56533", + "resource_availability" : "true" + }, { + "code" : "region02", + "port" : "8404", + "name" : "AZ 2.", + "id" : "a0865121f83b41cbafce65930a22a6e8", + "resource_availability" : "true" + }, { + "code" : "region03", + "port" : "8408", + "name" : "AZ 3.", + "id" : "2dcb154ac2724a6d92e9bcc859657c1e", + "resource_availability" : "true" + } ] + } + +Status Codes +------------ + +=========== ======================== +Status Code Description +=========== ======================== +200 The query is successful. +=========== ======================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/other_apis/querying_product_flavors.rst b/api-ref/source/api_v2/other_apis/querying_product_flavors.rst new file mode 100644 index 0000000..936ba16 --- /dev/null +++ b/api-ref/source/api_v2/other_apis/querying_product_flavors.rst @@ -0,0 +1,431 @@ +:original_name: ListFlavors_0.html + +.. _ListFlavors_0: + +Querying Product Flavors +======================== + +Function +-------- + +This API is used to query the product flavor (parameter **spec_code**) required for configuring a new DCS instance. If no search criterion is specified, all product specifications will be queried by default. + +URI +--- + +GET /v2/{project_id}/flavors + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================================================================================================================================================================================================================================================================================================+ + | spec_code | No | String | Product flavor. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cache_mode | No | String | DCS instance type. Options: | + | | | | | + | | | | - **single**: single-node | + | | | | | + | | | | - **ha**: master/standby | + | | | | | + | | | | - **cluster**: Redis Cluster | + | | | | | + | | | | - **proxy**: Proxy Cluster | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine | No | String | Cache engine. Options: | + | | | | | + | | | | - Redis | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_version | No | String | Cache engine version. If the cache engine is Redis, the options are as follows: | + | | | | | + | | | | - **3.0** | + | | | | | + | | | | - **4.0** | + | | | | | + | | | | - **5.0** | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cpu_type | No | String | CPU architecture. The options are as follows: | + | | | | | + | | | | - **x86_64**: x86 architecture | + | | | | | + | | | | - **aarch64**: Arm architecture | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **x86_64** | + | | | | | + | | | | - **aarch64** | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | capacity | No | String | Cache capacity (GB). | + | | | | | + | | | | - For a single-node or master/standby DCS Redis 3.0 instance, the value can be **2**, **4**, **8**, **16**, **32**, or **64**. For a Proxy Cluster DCS Redis 3.0 instance, the value can be **64**, **128**, **256**, **512**, or **1024**. | + | | | | | + | | | | - For a single-node or master/standby DCS Redis 4.0 or 5.0 instance, the value can be **0.125**, **0.25**, **0.5**, **1**, **2**, **4**, **8**, **16**, **32**, or **64**. For a Redis Cluster DCS Redis 4.0 or 5.0 instance, the value can be **24**, **32**, **48**, **64**, **96**, **128**, **192**, **256**, **384**, **512**, **768**, or **1024**. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+-----------------------------------------------------------------------------+-------------------------+ + | Parameter | Type | Description | + +===========+=============================================================================+=========================+ + | flavors | Array of :ref:`FlavorsItems ` objects | Product flavor details. | + +-----------+-----------------------------------------------------------------------------+-------------------------+ + +.. _listflavors_0__response_flavorsitems: + +.. table:: **Table 4** FlavorsItems + + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=================================================================================+====================================================================================================+ + | spec_code | String | Product flavor. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | cloud_service_type_code | String | Code of the cloud service type. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | cloud_resource_type_code | String | Code of the cloud resource type. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | cache_mode | String | DCS instance type. Options: | + | | | | + | | | - **single**: single-node | + | | | | + | | | - **ha**: master/standby | + | | | | + | | | - **cluster**: Redis Cluster | + | | | | + | | | - **proxy**: Proxy Cluster | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | engine | String | Cache engine. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | engine_version | String | Cache engine version. If the cache engine is Redis, the value can be **3.0**, **4.0**, or **5.0**. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | product_type | String | Edition of DCS for Redis. Currently, only the following value is supported: **generic**: standard | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | cpu_type | String | CPU architecture. The options are as follows: | + | | | | + | | | - **x86_64**: x86 architecture | + | | | | + | | | - **aarch64**: Arm architecture | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | storage_type | String | Storage type. Currently, only the following value is supported: **DRAM**: in-memory storage | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | capacity | Array of strings | Cache capacity (GB). | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | billing_mode | Array of strings | Billing mode. The value can be: | + | | | | + | | | - **Hourly**: pay-per-use | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | tenant_ip_count | Integer | Number of tenant IP addresses. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | pricing_type | String | Pricing type. The options are as follows: | + | | | | + | | | - **tier**: Tiered pricing. One flavor corresponds to multiple capacity options. | + | | | | + | | | - **normal**: One flavor corresponds to one capacity option. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | is_dec | Boolean | Whether Dedicated Cloud (DeC) is supported. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | attrs | Array of :ref:`AttrsObject ` objects | Other information about the flavor. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | flavors_available_zones | Array of :ref:`FlavorAzObject ` objects | AZs where there are available resources. | + +--------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + +.. _listflavors_0__response_attrsobject: + +.. table:: **Table 5** AttrsObject + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================================================================================================================================+ + | capacity | String | Cache capacity (GB). | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Additional information items. The options are as follows: | + | | | | + | | | - **sharding_num**: Number of shards supported by the flavor. | + | | | | + | | | - **proxy_num**: Number of proxies supported by Proxy Cluster instances of the specified flavor. If the instance is not a Proxy Cluster instance, the value of this parameter is **0**. | + | | | | + | | | - **db_number**: Number of DBs of the flavor. | + | | | | + | | | - **max_memory**: Maximum available memory. | + | | | | + | | | - **max_connections**: Maximum number of connections supported by the flavor. | + | | | | + | | | - **max_clients**: Maximum number of clients supported by the flavor, which is usually equal to the maximum number of connections. | + | | | | + | | | - **max_bandwidth**: Maximum bandwidth supported by the flavor. | + | | | | + | | | - **max_in_bandwidth**: Maximum inbound bandwidth supported by the flavor, which is usually equal to the maximum bandwidth. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value | String | Additional information value. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listflavors_0__response_flavorazobject: + +.. table:: **Table 6** FlavorAzObject + + ========= ================ ======================================== + Parameter Type Description + ========= ================ ======================================== + capacity String Cache capacity (GB). + az_codes Array of strings AZs where there are available resources. + ========= ================ ======================================== + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 10** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 11** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/flavors?cache_mode={cache_mode}&engine={engine}&engine_version={engine_version}&cpu_type={cpu_type}&capacity={capacity} + +Example Responses +----------------- + +**Status code: 200** + +Product flavors queried successfully. + +.. code-block:: + + { + "flavors" : [ { + "spec_code" : "redis.single.au1.large.1", + "cloud_service_type_code" : "hws.resource.type.dcs3", + "cloud_resource_type_code" : "hws.resource.type.dcs3", + "cache_mode" : "single", + "engine" : "redis", + "engine_version" : "4.0;5.0", + "product_type" : "generic", + "cpu_type" : "aarch64", + "storage_type" : "DRAM", + "capacity" : [ 1 ], + "billing_mode" : [ "Hourly" ], + "tenant_ip_count" : 1, + "pricing_type" : "normal", + "is_dec" : false, + "attrs" : [ { + "capacity" : 1, + "name" : "max_memory", + "value" : 1 + }, { + "capacity" : 1, + "name" : "max_connections", + "value" : 10000 + }, { + "capacity" : 1, + "name" : "sharding_num", + "value" : 1 + }, { + "capacity" : 1, + "name" : "proxy_num", + "value" : 0 + }, { + "capacity" : 1, + "name" : "db_number", + "value" : 256 + }, { + "capacity" : 1, + "name" : "max_clients", + "value" : 10000 + }, { + "capacity" : 1, + "name" : "max_bandwidth", + "value" : 80 + } ], + "flavors_available_zones" : [ { + "capacity" : 1, + "az_codes" : [ "region01" ] + } ] + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.1004", + "error_msg" : "Project ID does not match the token." + } + +**Status code: 401** + +Invalid authentication information. + +.. code-block:: + + { + "error_code" : "DCS.1001", + "error_msg" : "Invalid token." + } + +**Status code: 403** + +The request is rejected. + +.. code-block:: + + { + "error_code" : "DCS.2003", + "error_msg" : "This role does not have the permission to perform this operation." + } + +**Status code: 404** + +The requested resource is not found. + +.. code-block:: + + { + "error_code" : "DCS.4001", + "error_msg" : "The requested URL does not exist." + } + +**Status code: 500** + +Internal service error. + +.. code-block:: + + { + "error_code" : "DCS.5000", + "error_msg" : "Internal service error." + } + +Status Codes +------------ + +=========== ===================================== +Status Code Description +=========== ===================================== +200 Product flavors queried successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ===================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/other_apis/querying_the_tenant_quotas.rst b/api-ref/source/api_v2/other_apis/querying_the_tenant_quotas.rst new file mode 100644 index 0000000..84a6921 --- /dev/null +++ b/api-ref/source/api_v2/other_apis/querying_the_tenant_quotas.rst @@ -0,0 +1,176 @@ +:original_name: ShowQuotaOfTenant_0.html + +.. _ShowQuotaOfTenant_0: + +Querying the Tenant Quotas +========================== + +Function +-------- + +This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions. + +URI +--- + +GET /v2/{project_id}/quota + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------+-------------------------------------------------------------+--------------------+ + | Parameter | Type | Description | + +===========+=============================================================+====================+ + | quotas | :ref:`quotas ` object | Quota information. | + +-----------+-------------------------------------------------------------+--------------------+ + +.. _showquotaoftenant_0__response_quotas: + +.. table:: **Table 3** quotas + + +-----------+-----------------------------------------------------------------------------+----------------+ + | Parameter | Type | Description | + +===========+=============================================================================+================+ + | resources | Array of :ref:`Resources ` objects | List of quotas | + +-----------+-----------------------------------------------------------------------------+----------------+ + +.. _showquotaoftenant_0__response_resources: + +.. table:: **Table 4** Resources + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================+ + | unit | String | Resource unit. | + | | | | + | | | - When **type** is set to **instance**, no value is returned. | + | | | | + | | | - When **type** is set to **ram**, **GB** is returned. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | min | Integer | Minimum limit of instance quota when **type** is set to **instance**. | + | | | | + | | | - Minimum limit of memory quota when **type** is set to **ram**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | max | Integer | Maximum limit of instance quota when **type** is set to **instance**. | + | | | | + | | | - Maximum limit of memory quota when **type** is set to **ram**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | quota | Integer | Maximum number of instances that can be created and maximum allowed total memory. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | used | Integer | Number of created instances and used memory. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + | type | String | The value can be **instance** or **ram**. | + | | | | + | | | - **instances**: instance quota | + | | | | + | | | - **ram**: memory quota | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/quota + +Example Responses +----------------- + +**Status code: 200** + +Tenant quota queried successfully. + +.. code-block:: + + { + "quotas" : { + "resources" : [ { + "unit" : { }, + "min" : 1, + "max" : 10, + "quota" : 10, + "used" : 3, + "type" : "instance" + }, { + "unit" : "GB", + "min" : 1, + "max" : 800, + "quota" : 800, + "used" : 22, + "type" : "ram" + } ] + } + } + +Status Codes +------------ + +=========== ================================== +Status Code Description +=========== ================================== +200 Tenant quota queried successfully. +400 Invalid request. +500 Internal service error. +=========== ================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/parameter_management/index.rst b/api-ref/source/api_v2/parameter_management/index.rst new file mode 100644 index 0000000..ba61c7e --- /dev/null +++ b/api-ref/source/api_v2/parameter_management/index.rst @@ -0,0 +1,18 @@ +:original_name: ParamManagement_0.html + +.. _ParamManagement_0: + +Parameter Management +==================== + +- :ref:`Querying DCS Instance Configuration Parameters ` +- :ref:`Modifying Configuration Parameters ` +- :ref:`Querying the List of Instance Parameter Modification Records ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_dcs_instance_configuration_parameters + modifying_configuration_parameters + querying_the_list_of_instance_parameter_modification_records diff --git a/api-ref/source/api_v2/parameter_management/modifying_configuration_parameters.rst b/api-ref/source/api_v2/parameter_management/modifying_configuration_parameters.rst new file mode 100644 index 0000000..d384e76 --- /dev/null +++ b/api-ref/source/api_v2/parameter_management/modifying_configuration_parameters.rst @@ -0,0 +1,127 @@ +:original_name: UpdateConfigurations_0.html + +.. _UpdateConfigurations_0: + +Modifying Configuration Parameters +================================== + +Function +-------- + +You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements. + +URI +--- + +PUT /v2/{project_id}/instances/{instance_id}/configs + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +--------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+===================================================================================+===================================================+ + | redis_config | No | Array of :ref:`RedisConfig ` objects | Array of configuration items of the DCS instance. | + +--------------+-----------+-----------------------------------------------------------------------------------+---------------------------------------------------+ + +.. _updateconfigurations_0__request_redisconfig: + +.. table:: **Table 3** RedisConfig + + =========== ========= ====== ================================ + Parameter Mandatory Type Description + =========== ========= ====== ================================ + param_value Yes String Value of the configuration item. + param_name Yes String Configuration item name. + param_id Yes String Configuration item ID. + =========== ========= ====== ================================ + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + PUT https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs + + { + "redis_config" : [ { + "param_id" : 1, + "param_name" : "timeout", + "param_value" : 1000 + } ] + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ================================================== +Status Code Description +=========== ================================================== +204 DCS instance configurations modified successfully. +400 Invalid request. +500 Internal service error. +=========== ================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/parameter_management/querying_dcs_instance_configuration_parameters.rst b/api-ref/source/api_v2/parameter_management/querying_dcs_instance_configuration_parameters.rst new file mode 100644 index 0000000..b2a5881 --- /dev/null +++ b/api-ref/source/api_v2/parameter_management/querying_dcs_instance_configuration_parameters.rst @@ -0,0 +1,169 @@ +:original_name: ListConfigurations_0.html + +.. _ListConfigurations_0: + +Querying DCS Instance Configuration Parameters +============================================== + +Function +-------- + +This API is used to query the configuration parameters of a DCS instance. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/configs + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + instance_id Yes String Instance ID. + project_id Yes String Project ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================================+================================================================================+ + | config_time | String | Time when the instance was operated on. For example, 2017-03-31T12:24:46.297Z. | + +-----------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | instance_id | String | Instance ID. | + +-----------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | redis_config | Array of :ref:`QueryRedisConfig ` objects | Array of configuration items of the DCS instance. | + +-----------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | config_status | String | Instance modification status. | + | | | | + | | | - UPDATING | + | | | | + | | | - FAILURE | + | | | | + | | | - SUCCESS | + | | | | + | | | Enumeration values: | + | | | | + | | | - **UPDATING** | + | | | | + | | | - **FAILURE** | + | | | | + | | | - **SUCCESS** | + +-----------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + | status | String | Instance status. | + +-----------------------+--------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ + +.. _listconfigurations_0__response_queryredisconfig: + +.. table:: **Table 3** QueryRedisConfig + + ============= ====== ============================================= + Parameter Type Description + ============= ====== ============================================= + param_value String Configuration parameter value. + value_type String Type of the configuration parameter value. + value_range String Range of the configuration parameter value. + description String Description of the configuration item. + default_value String Default value of the configuration parameter. + param_name String Configuration parameter name. + param_id String Configuration parameter ID. + ============= ====== ============================================= + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/configs + +Example Responses +----------------- + +**Status code: 200** + +Instance configuration parameters queried successfully. + +.. code-block:: + + { + "instance_id" : "50829e5a-a4fc-4c01-8651-80be8a491602", + "config_status" : "SUCCESS", + "config_time" : "2020-07-06T07:04:31.464Z", + "redis_config" : [ { + "param_id" : "1", + "param_name" : "timeout", + "description" : "Close the connection after a client is idle for N seconds (0 to disable)", + "param_value" : "101", + "value_range" : "0-7200", + "value_type" : "Interger", + "default_value" : "0" + } ], + "status" : "RUNNING" + } + +Status Codes +------------ + +=========== ======================================================= +Status Code Description +=========== ======================================================= +200 Instance configuration parameters queried successfully. +400 Invalid request. +500 Internal service error. +=========== ======================================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/parameter_management/querying_the_list_of_instance_parameter_modification_records.rst b/api-ref/source/api_v2/parameter_management/querying_the_list_of_instance_parameter_modification_records.rst new file mode 100644 index 0000000..d62de63 --- /dev/null +++ b/api-ref/source/api_v2/parameter_management/querying_the_list_of_instance_parameter_modification_records.rst @@ -0,0 +1,152 @@ +:original_name: ListConfigHistories_0.html + +.. _ListConfigHistories_0: + +Querying the List of Instance Parameter Modification Records +============================================================ + +Function +-------- + +This API is used to query the parameter modification record list of an instance by keyword. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/config-histories + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +.. table:: **Table 2** Query Parameters + + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+================================================================================================================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records displayed on each page. The minimum value is **1**. The maximum value is **1000**\ \*. If this parameter is not specified, 10 records are displayed on each page by default. | + +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+ + | Parameter | Type | Description | + +=============+===================================================================================+=====================================================+ + | history_num | Integer | Number of instance parameter modification records. | + +-------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+ + | histories | Array of :ref:`HistoryInfo ` objects | Details of instance parameter modification records. | + +-------------+-----------------------------------------------------------------------------------+-----------------------------------------------------+ + +.. _listconfighistories_0__response_historyinfo: + +.. table:: **Table 4** HistoryInfo + + ========== ====== ======================= + Parameter Type Description + ========== ====== ======================= + history_id String Modification record ID. + type String Modification type. + created_at String Modification time. + status String Modification status. + ========== ====== ======================= + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/config-histories?offset=0&limit=10 + +Example Responses +----------------- + +**Status code: 200** + +List of instance parameter modification records queried successfully. + +.. code-block:: + + { + "history_num" : 1, + "histories" : [ { + "history_id" : "4ae8507f-7992-40e2-9928-41ccf1db4bdc", + "type" : "config_param", + "created_at" : "2022-10-20T03:37:44.636Z", + "status" : "SUCCESS" + } ] + } + +Status Codes +------------ + ++-------------+-----------------------------------------------------------------------+ +| Status Code | Description | ++=============+=======================================================================+ +| 200 | List of instance parameter modification records queried successfully. | ++-------------+-----------------------------------------------------------------------+ +| 400 | Invalid request. | ++-------------+-----------------------------------------------------------------------+ +| 500 | Internal service error. | ++-------------+-----------------------------------------------------------------------+ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/shards_and_replicas/configuring_replica_priority.rst b/api-ref/source/api_v2/shards_and_replicas/configuring_replica_priority.rst new file mode 100644 index 0000000..1802401 --- /dev/null +++ b/api-ref/source/api_v2/shards_and_replicas/configuring_replica_priority.rst @@ -0,0 +1,176 @@ +:original_name: UpdateSlavePriority_0.html + +.. _UpdateSlavePriority_0: + +Configuring Replica Priority +============================ + +Function +-------- + +This API is used to configure the replica priority. When the master node is faulty, a replica with a smaller weight has a higher priority to be promoted to master. + +URI +--- + +POST /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/slave-priority + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + group_id Yes String Shard ID. + node_id Yes String Node ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+====================================================================================================================+ + | slave_priority_weight | Yes | Integer | Replica priority. The value ranges from 0 to 100. Value **0** indicates that the promotion is disabled by default. | + +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/replications/{node_id}/slave-priority + + { + "slave_priority_weight" : 100 + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ========================================= +Status Code Description +=========== ========================================= +204 Replica priority configured successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ========================================= + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/shards_and_replicas/index.rst b/api-ref/source/api_v2/shards_and_replicas/index.rst new file mode 100644 index 0000000..395aa03 --- /dev/null +++ b/api-ref/source/api_v2/shards_and_replicas/index.rst @@ -0,0 +1,20 @@ +:original_name: GroupReplicationManagement_0.html + +.. _GroupReplicationManagement_0: + +Shards and Replicas +=================== + +- :ref:`Configuring Replica Priority ` +- :ref:`Removing the IP Address ` +- :ref:`Querying Details of Shards ` +- :ref:`Querying Instance Nodes in Batches ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + configuring_replica_priority + removing_the_ip_address + querying_details_of_shards + querying_instance_nodes_in_batches diff --git a/api-ref/source/api_v2/shards_and_replicas/querying_details_of_shards.rst b/api-ref/source/api_v2/shards_and_replicas/querying_details_of_shards.rst new file mode 100644 index 0000000..0d08a5c --- /dev/null +++ b/api-ref/source/api_v2/shards_and_replicas/querying_details_of_shards.rst @@ -0,0 +1,289 @@ +:original_name: ListGroupReplicationInfo_0.html + +.. _ListGroupReplicationInfo_0: + +Querying Details of Shards +========================== + +Function +-------- + +This API is used to query shards and replicas of cluster instances. + +URI +--- + +GET /v2/{project_id}/instance/{instance_id}/groups + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | Parameter | Type | Description | + +=============+============================================================================================================+=========================================+ + | group_list | Array of :ref:`InstanceGroupListInfo ` objects | Shard list. | + +-------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + | group_count | Integer | Total number of shards in the instance. | + +-------------+------------------------------------------------------------------------------------------------------------+-----------------------------------------+ + +.. _listgroupreplicationinfo_0__response_instancegrouplistinfo: + +.. table:: **Table 3** InstanceGroupListInfo + + +------------------+------------------------------------------------------------------------------------------------------------------------+--------------------------------+ + | Parameter | Type | Description | + +==================+========================================================================================================================+================================+ + | group_id | String | Shard ID. | + +------------------+------------------------------------------------------------------------------------------------------------------------+--------------------------------+ + | group_name | String | Shard name. | + +------------------+------------------------------------------------------------------------------------------------------------------------+--------------------------------+ + | replication_list | Array of :ref:`InstanceReplicationListInfo ` objects | List of replicas in the shard. | + +------------------+------------------------------------------------------------------------------------------------------------------------+--------------------------------+ + +.. _listgroupreplicationinfo_0__response_instancereplicationlistinfo: + +.. table:: **Table 4** InstanceReplicationListInfo + + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================================================================+===============================================================================================================================================================================================================================+ + | replication_role | String | Role of the replica. Options: | + | | | | + | | | - **master**: master | + | | | | + | | | - **slave**: replica | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | replication_ip | String | Replica IP address. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_replication | Boolean | Whether the replica is a newly added one. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | replication_id | String | Replica ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_id | String | Node ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Replica status. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **Active** | + | | | | + | | | - **Inactive** | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_code | String | AZ where the replica is in. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dimensions | Array of :ref:`InstanceReplicationDimensionsInfo ` objects | Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics. | + | | | | + | | | - Replica monitoring is multi-dimensional. The returned array contains information about two dimensions. When querying monitoring data from Cloud Eye, transfer parameters of multiple dimensions to obtain the metric data. | + | | | | + | | | - The first dimension is the primary dimension of the replica. The dimension name is **dcs_instance_id**, and the dimension value corresponds to the ID of the instance to which the replica belongs. | + | | | | + | | | - The name of the second dimension is **dcs_cluster_redis_node**, and the dimension value is the monitored object ID of the replica, which is different from the replica ID or node ID. | + +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listgroupreplicationinfo_0__response_instancereplicationdimensionsinfo: + +.. table:: **Table 5** InstanceReplicationDimensionsInfo + + ========= ====== ========================== + Parameter Type Description + ========= ====== ========================== + name String Monitoring dimension name. + value String Dimension value. + ========= ====== ========================== + +**Status code: 500** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups + +Example Responses +----------------- + +**Status code: 200** + +Details of shards and replicas queried successfully. + +.. code-block:: + + { + "group_list" : [ { + "group_id" : "35e1bed6-7de5-4898-9eb2-c362c783df15", + "group_name" : "group-0", + "replication_list" : [ { + "az_code" : "region01", + "is_replication" : false, + "node_id" : "8abfa7aa73291f15017329e1cda0002d", + "replication_id" : "dfbd3f84-08bc-42f0-b538-01d03e6dc178", + "replication_ip" : "192.168.76.25", + "replication_role" : "master", + "status" : "Active", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6200" + } ] + }, { + "az_code" : "region01", + "is_replication" : false, + "node_id" : "8abfa7aa73291f15017329e1cdb0002e", + "replication_id" : "63d4c880-7050-464f-ab19-c8a297474d7d", + "replication_ip" : "192.168.78.207", + "replication_role" : "slave", + "status" : "Active", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6201" + } ] + } ] + }, { + "group_id" : "579a281f-6e63-4822-b0c7-e45c44b7c807", + "group_name" : "group-1", + "replication_list" : [ { + "az_code" : "region01", + "is_replication" : false, + "node_id" : "8abfa7aa73291f15017329e1cdbd002f", + "replication_id" : "6284c192-48d1-462b-8fd9-45dad067c1a2", + "replication_ip" : "192.168.73.164", + "replication_role" : "master", + "status" : "Active", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6202" + } ] + }, { + "az_code" : "region01", + "is_replication" : false, + "node_id" : "8abfa7aa73291f15017329e1cdc80030", + "replication_id" : "b927de3b-42f3-45b5-b0e4-8547f0ef6727", + "replication_ip" : "192.168.77.172", + "replication_role" : "slave", + "status" : "Active", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6203" + } ] + } ] + }, { + "group_id" : "c17305c6-6651-42d9-86bf-5a6087076eb7", + "group_name" : "group-2", + "replication_list" : [ { + "az_code" : "region01", + "is_replication" : false, + "node_id" : "8abfa7aa73291f15017329e1cdd90031", + "replication_id" : "caa6636d-a5c1-43b8-990a-3dc134da4522", + "replication_ip" : "192.168.76.143", + "replication_role" : "master", + "status" : "Active", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6204" + } ] + }, { + "az_code" : "region01", + "is_replication" : false, + "node_id" : "8abfa7aa73291f15017329e1cde50032", + "replication_id" : "4f46790d-a0b0-4a1b-aa02-1c554fccf62d", + "replication_ip" : "192.168.72.66", + "replication_role" : "slave", + "status" : "Active", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6205" + } ] + } ] + } ], + "group_count" : 3 + } + +Status Codes +------------ + +=========== ==================================================== +Status Code Description +=========== ==================================================== +200 Details of shards and replicas queried successfully. +500 Internal service error. +400 Invalid request. +=========== ==================================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/shards_and_replicas/querying_instance_nodes_in_batches.rst b/api-ref/source/api_v2/shards_and_replicas/querying_instance_nodes_in_batches.rst new file mode 100644 index 0000000..6468103 --- /dev/null +++ b/api-ref/source/api_v2/shards_and_replicas/querying_instance_nodes_in_batches.rst @@ -0,0 +1,302 @@ +:original_name: BatchShowNodesInformation_0.html + +.. _BatchShowNodesInformation_0: + +Querying Instance Nodes in Batches +================================== + +Function +-------- + +This API is used to query the node information, number of valid instances, and number of nodes of all instances in a specified project. No node information will be returned when the instance is being created. Only DCS Redis 4.0, 5.0, and 6.0 instances can be queried. + +Constraints +----------- + +Only DCS Redis 4.0, 5.0, and 6.0 instances can be queried. + +URI +--- + +GET /v2/{project_id}/instances-logical-nodes + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+=========+================================================================================================================================================================+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of items displayed on each page. The maximum value is **1000**\ \*. If this parameter is not specified, 10 items are displayed on each page by default. | + +-----------+-----------+---------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+-------------------------------------------------------------------------------------------------------------+------------------------------------------------+ + | Parameter | Type | Description | + +===========+=============================================================================================================+================================================+ + | count | Integer | Total number of instances in the query result. | + +-----------+-------------------------------------------------------------------------------------------------------------+------------------------------------------------+ + | instances | Array of :ref:`InstanceNodesInfoResp ` objects | Instance list. | + +-----------+-------------------------------------------------------------------------------------------------------------+------------------------------------------------+ + +.. _batchshownodesinformation_0__response_instancenodesinforesp: + +.. table:: **Table 4** InstanceNodesInfoResp + + +-------------+---------------------------------------------------------------------------------------------+------------------------------------------------+ + | Parameter | Type | Description | + +=============+=============================================================================================+================================================+ + | instance_id | String | Instance ID. | + +-------------+---------------------------------------------------------------------------------------------+------------------------------------------------+ + | node_count | Integer | Total number of nodes of the current instance. | + +-------------+---------------------------------------------------------------------------------------------+------------------------------------------------+ + | nodes | Array of :ref:`NodesInfoResp ` objects | Node details. | + +-------------+---------------------------------------------------------------------------------------------+------------------------------------------------+ + +.. _batchshownodesinformation_0__response_nodesinforesp: + +.. table:: **Table 5** NodesInfoResp + + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=====================================================================================================================================+===============================================================================================================================================================================================================================+ + | logical_node_id | String | Logical node ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Node name. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Node status. The value can be: | + | | | | + | | | - **Creating** | + | | | | + | | | - **Active**: running | + | | | | + | | | - **Inactive**: faulty | + | | | | + | | | - **Deleting** | + | | | | + | | | - **AddSharding**: Shards are being added. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **Creating** | + | | | | + | | | - **Active** | + | | | | + | | | - **Inactive** | + | | | | + | | | - **Deleting** | + | | | | + | | | - **AddSharding** | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | az_code | String | AZ code. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_role | String | Node type. The value can be: | + | | | | + | | | - **redis-server**: Redis server node. | + | | | | + | | | - **redis-proxy**: proxy node. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **redis-server** | + | | | | + | | | - **redis-proxy** | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_type | String | Node role. The value can be: | + | | | | + | | | - **master** | + | | | | + | | | - **slave** | + | | | | + | | | - **proxy**: node of a Proxy Cluster instance. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **master** | + | | | | + | | | - **slave** | + | | | | + | | | - **proxy** | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_ip | String | Node IP address. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_port | String | Node port. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_id | String | Node ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | priority_weight | Integer | Node weight. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_access | Boolean | Whether the IP address of the node can be directly accessed. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | group_id | String | Shard ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | group_name | String | Shard name. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_remove_ip | Boolean | Whether the IP address is removed from the read-only domain name. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | replication_id | String | Replica ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dimensions | Array of :ref:`InstanceReplicationDimensionsInfo ` objects | Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics. | + | | | | + | | | - Replica monitoring is multi-dimensional. The returned array contains information about two dimensions. When querying monitoring data from Cloud Eye, transfer parameters of multiple dimensions to obtain the metric data. | + | | | | + | | | - The first dimension is the primary dimension of the replica. The dimension name is **dcs_instance_id**, and the dimension value is the ID of the instance where the replica is located. | + | | | | + | | | - The name of the second dimension is **dcs_cluster_redis_node**, and the dimension value is the monitored object ID of the replica, which is different from the replica ID or node ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _batchshownodesinformation_0__response_instancereplicationdimensionsinfo: + +.. table:: **Table 6** InstanceReplicationDimensionsInfo + + ========= ====== ========================== + Parameter Type Description + ========= ====== ========================== + name String Monitoring dimension name. + value String Dimension value. + ========= ====== ========================== + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances-logical-nodes?offset={offset}&limit={limit} + +Example Responses +----------------- + +**Status code: 200** + +Node information queried successfully. + +.. code-block:: + + { + "count" : 1, + "instances" : [ { + "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c", + "node_count" : 2, + "nodes" : [ { + "logical_node_id" : "8f997eb512a92834bf5914be52ca8919", + "name" : "(replica)192.168.0.178", + "status" : "Active", + "az_code" : "region01", + "node_role" : "redis-server", + "node_type" : "slave", + "node_ip" : "192.168.0.178", + "node_port" : "6379", + "node_id" : "8a2c26c17f4d6516017f4d7b77940030", + "is_access" : true, + "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3", + "group_name" : "group-0", + "priority_weight" : 100, + "is_remove_ip" : false, + "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544", + "dimensions" : [ { + "name" : "dcs_instance_id", + "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" + }, { + "name" : "dcs_cluster_redis_node", + "value" : "8263dc69629c5b2d840e9816fa9c6200" + } ] + } ] + } ] + } + +**Status code: 500** + +Internal service error. + +.. code-block:: + + { + "error_code" : "DCS.5000", + "error_msg" : "Internal service error." + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "DCS.4800", + "error_msg" : "Invalid offset in the request." + } + +Status Codes +------------ + +=========== ====================================== +Status Code Description +=========== ====================================== +200 Node information queried successfully. +500 Internal service error. +400 Invalid request. +=========== ====================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/shards_and_replicas/removing_the_ip_address.rst b/api-ref/source/api_v2/shards_and_replicas/removing_the_ip_address.rst new file mode 100644 index 0000000..f60ca50 --- /dev/null +++ b/api-ref/source/api_v2/shards_and_replicas/removing_the_ip_address.rst @@ -0,0 +1,176 @@ +:original_name: DeleteIpFromDomainName_0.html + +.. _DeleteIpFromDomainName_0: + +Removing the IP Address +======================= + +Function +-------- + +This API is used to remove the IP address of a read replica from the domain name. After the removal, the read-only domain name will not be resolved to the IP address. + +URI +--- + +DELETE /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + group_id Yes String Shard ID. + node_id Yes String Node ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + ========= ====== =================================== + Parameter Type Description + ========= ====== =================================== + job_id String ID of the IP address removing task. + ========= ====== =================================== + +**Status code: 400** + +.. table:: **Table 3** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== ==================================== +Status Code Description +=========== ==================================== +200 IP address removed successfully. +400 Invalid request. +401 Invalid authentication information. +403 The request is rejected. +404 The requested resource is not found. +500 Internal service error. +=========== ==================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/tag_management/batch_adding_or_deleting_tags.rst b/api-ref/source/api_v2/tag_management/batch_adding_or_deleting_tags.rst new file mode 100644 index 0000000..d76fb36 --- /dev/null +++ b/api-ref/source/api_v2/tag_management/batch_adding_or_deleting_tags.rst @@ -0,0 +1,104 @@ +:original_name: BatchCreateOrDeleteTags_0.html + +.. _BatchCreateOrDeleteTags_0: + +Batch Adding or Deleting Tags +============================= + +Function +-------- + +This API is used to add or delete tags in batches for a DCS instance. + +URI +--- + +POST /v2/{project_id}/dcs/{instance_id}/tags/action + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-----------+-----------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+======================================================================================+=======================================================================+ + | action | Yes | String | Operation to be performed. The value can be **create** or **delete**. | + +-----------+-----------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + | tags | No | Array of :ref:`ResourceTag ` objects | Tag list. | + +-----------+-----------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +.. _batchcreateordeletetags_0__request_resourcetag: + +.. table:: **Table 3** ResourceTag + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================================================+ + | key | Yes | String | Tag key. | + | | | | | + | | | | - This field cannot be left blank. | + | | | | | + | | | | - The key value of a resource must be unique. | + | | | | | + | | | | - The tag key can contain a maximum of 36 characters. | + | | | | | + | | | | - The tag key must be unique and cannot be empty. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + | value | No | String | Tag value. | + | | | | | + | | | | - This parameter is mandatory when **action** is set to **create** and is optional when **action** is set to **delete**. | + | | | | | + | | | | - The tag value can contain a maximum of 43 characters. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +None + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/7dddae81f0e34f62adb9618bc8c8b1fe/dcs/01928d55-7020-4500-9c29-774caabe4bc4/tags/action + + { + "action" : "create", + "tags" : [ { + "value" : 2, + "key" : "dcs001" + }, { + "value" : 4, + "key" : "dcs003" + } ] + } + +Example Responses +----------------- + +None + +Status Codes +------------ + +=========== =================================== +Status Code Description +=========== =================================== +204 Tags added or deleted successfully. +=========== =================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/tag_management/index.rst b/api-ref/source/api_v2/tag_management/index.rst new file mode 100644 index 0000000..8c613ff --- /dev/null +++ b/api-ref/source/api_v2/tag_management/index.rst @@ -0,0 +1,18 @@ +:original_name: TagManagement.html + +.. _TagManagement: + +Tag Management +============== + +- :ref:`Listing All Tags of a Tenant ` +- :ref:`Batch Adding or Deleting Tags ` +- :ref:`Querying Tags of a DCS Instance ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + listing_all_tags_of_a_tenant + batch_adding_or_deleting_tags + querying_tags_of_a_dcs_instance diff --git a/api-ref/source/api_v2/tag_management/listing_all_tags_of_a_tenant.rst b/api-ref/source/api_v2/tag_management/listing_all_tags_of_a_tenant.rst new file mode 100644 index 0000000..1f24be1 --- /dev/null +++ b/api-ref/source/api_v2/tag_management/listing_all_tags_of_a_tenant.rst @@ -0,0 +1,136 @@ +:original_name: ListTagsOfTenant_0.html + +.. _ListTagsOfTenant_0: + +Listing All Tags of a Tenant +============================ + +Function +-------- + +This API is used to query the tags of all resources owned by a tenant in a specific project. + +URI +--- + +GET /v2/{project_id}/dcs/tags + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------+----------------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +===========+================================================================+=============+ + | tags | Array of :ref:`Tag ` objects | Tag list. | + +-----------+----------------------------------------------------------------+-------------+ + +.. _listtagsoftenant_0__response_tag: + +.. table:: **Table 3** Tag + + +-----------+------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==================+================================================================+ + | key | String | Tag key, which can contain a maximum of 36 Unicode characters. | + +-----------+------------------+----------------------------------------------------------------+ + | values | Array of strings | Tag value. | + +-----------+------------------+----------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/dcs/tags + +Example Responses +----------------- + +**Status code: 200** + +Successfully queried all tags of the tenant. + +.. code-block:: + + { + "tags" : [ { + "values" : [ "value1", "value2" ], + "key" : 1 + }, { + "values" : [ "value1", "value2" ], + "key" : 2 + } ] + } + +Status Codes +------------ + +=========== ============================================ +Status Code Description +=========== ============================================ +200 Successfully queried all tags of the tenant. +400 Invalid request. +500 Internal service error. +=========== ============================================ + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/tag_management/querying_tags_of_a_dcs_instance.rst b/api-ref/source/api_v2/tag_management/querying_tags_of_a_dcs_instance.rst new file mode 100644 index 0000000..b1d9b9c --- /dev/null +++ b/api-ref/source/api_v2/tag_management/querying_tags_of_a_dcs_instance.rst @@ -0,0 +1,107 @@ +:original_name: ShowTags_0.html + +.. _ShowTags_0: + +Querying Tags of a DCS Instance +=============================== + +Function +-------- + +This API is used to query the tags of an instance by its instance ID. + +URI +--- + +GET /v2/{project_id}/instances/{instance_id}/tags + +.. table:: **Table 1** Path Parameters + + =========== ========= ====== ============ + Parameter Mandatory Type Description + =========== ========= ====== ============ + project_id Yes String Project ID. + instance_id Yes String Instance ID. + =========== ========= ====== ============ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameters + + +-----------+------------------------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +===========+========================================================================+=============+ + | tags | Array of :ref:`ResourceTag ` objects | Tag list. | + +-----------+------------------------------------------------------------------------+-------------+ + +.. _showtags_0__response_resourcetag: + +.. table:: **Table 3** ResourceTag + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================================+ + | key | String | Tag key. | + | | | | + | | | - This field cannot be left blank. | + | | | | + | | | - The key value of a resource must be unique. | + | | | | + | | | - The tag key can contain a maximum of 36 characters. | + | | | | + | | | - The tag key must be unique and cannot be empty. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value. | + | | | | + | | | - This parameter is mandatory when **action** is set to **create** and is optional when **action** is set to **delete**. | + | | | | + | | | - The tag value can contain a maximum of 43 characters. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/tags + +Example Responses +----------------- + +**Status code: 200** + +Instance tags queried successfully. + +.. code-block:: + + { + "tags" : [ { + "value" : "a", + "key" : 1 + }, { + "value" : "b", + "key" : 2 + } ] + } + +Status Codes +------------ + +=========== =================================== +Status Code Description +=========== =================================== +200 Instance tags queried successfully. +=========== =================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/template_management/creating_a_custom_template.rst b/api-ref/source/api_v2/template_management/creating_a_custom_template.rst new file mode 100644 index 0000000..37b163c --- /dev/null +++ b/api-ref/source/api_v2/template_management/creating_a_custom_template.rst @@ -0,0 +1,235 @@ +:original_name: CreateCustomTemplate_0.html + +.. _CreateCustomTemplate_0: + +Creating a Custom Template +========================== + +Function +-------- + +This API is used to create a custom template. + +URI +--- + +POST /v2/{project_id}/config-templates + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameters + + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+====================+==============================================================================+ + | template_id | No | String | Default template ID. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | name | Yes | String | Template name. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | type | No | String | Template type. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | engine | No | String | Cache engine: Redis. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | cache_mode | No | String | DCS instance type. The value can be: | + | | | | | + | | | | - **single**: single-node | + | | | | | + | | | | - **ha**: master/standby | + | | | | | + | | | | - **cluster**: Redis Cluster | + | | | | | + | | | | - **proxy**: Proxy Cluster | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | description | No | String | Description of the template. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | engine_version | No | String | Cache version. | + | | | | | + | | | | If the cache engine is Redis, the value can be **4.0**, **5.0**, or **6.0**. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + | params | No | Map | Parameter configuration. | + +-----------------+-----------------+--------------------+------------------------------------------------------------------------------+ + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + ========= ====== ============ + Parameter Type Description + ========= ====== ============ + id String Template ID. + ========= ====== ============ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + POST https://{dcs_endpoint}/v2/{project_id}/config-templates + + { + "name" : "Test", + "cache_mode" : "single", + "description" : "Test", + "engine" : "Redis", + "engine_version" : "5.0", + "params" : { + "latency-monitor-threshold" : 15 + }, + "template_id" : "11", + "type" : "sys" + } + +Example Responses +----------------- + +**Status code: 200** + +Custom template created successfully. + +.. code-block:: + + { + "id" : "efb1ba06-d3cd-4a77-9173-16f70f2d1343" + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "111400063", + "error_msg" : "Invalid {0} parameter in the request." + } + +Status Codes +------------ + +=========== ========================================== +Status Code Description +=========== ========================================== +200 Custom template created successfully. +400 Invalid request. +401 Invalid authentication information. +403 Request rejected. +404 The requested resource could not be found. +500 Internal service error. +=========== ========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v2/template_management/index.rst b/api-ref/source/api_v2/template_management/index.rst new file mode 100644 index 0000000..97d0401 --- /dev/null +++ b/api-ref/source/api_v2/template_management/index.rst @@ -0,0 +1,16 @@ +:original_name: ConfigTemplatesManagement_0.html + +.. _ConfigTemplatesManagement_0: + +Template Management +=================== + +- :ref:`Viewing Parameter Templates ` +- :ref:`Creating a Custom Template ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + viewing_parameter_templates + creating_a_custom_template diff --git a/api-ref/source/api_v2/template_management/viewing_parameter_templates.rst b/api-ref/source/api_v2/template_management/viewing_parameter_templates.rst new file mode 100644 index 0000000..70922fa --- /dev/null +++ b/api-ref/source/api_v2/template_management/viewing_parameter_templates.rst @@ -0,0 +1,301 @@ +:original_name: ListConfigTemplates_0.html + +.. _ListConfigTemplates_0: + +Viewing Parameter Templates +=========================== + +Function +-------- + +This API is used to query parameter templates of a tenant, and allows you to specify query criteria. + +URI +--- + +GET /v2/{project_id}/config-templates + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== + +.. table:: **Table 2** Query Parameters + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+================================================================================================================================================================================================+ + | name | No | String | Parameter template name. Fuzzy search is supported. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | template_id | No | String | Template ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | Yes | String | Template type. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **sys** | + | | | | | + | | | | - **user** | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine | No | String | Cache engine: Redis. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_version | No | String | Cache version. | + | | | | | + | | | | If the cache engine is Redis, the value can be **4.0**, **5.0**, or **6.0**. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cache_mode | No | String | DCS instance type. The value can be: | + | | | | | + | | | | - **single**: single-node | + | | | | | + | | | | - **ha**: master/standby | + | | | | | + | | | | - **cluster**: Redis Cluster | + | | | | | + | | | | - **proxy**: Proxy Cluster | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description of the template. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | No | Integer | Offset, which is the position where the query starts. The value must be greater than or equal to 0. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Number of records displayed on each page. The minimum value is **1**. The maximum value is **1000**\ \*. If this parameter is not specified, 10 records are displayed on each page by default. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +------------------+-----------------------------------------------------------------------------------------------------------+-------------------------+ + | Parameter | Type | Description | + +==================+===========================================================================================================+=========================+ + | template_num | Number | Number of templates. | + +------------------+-----------------------------------------------------------------------------------------------------------+-------------------------+ + | config_templates | Array of :ref:`ConfigTemplatesListInfo ` objects | Template details array. | + +------------------+-----------------------------------------------------------------------------------------------------------+-------------------------+ + +.. _listconfigtemplates_0__response_configtemplateslistinfo: + +.. table:: **Table 4** ConfigTemplatesListInfo + + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==============================================================================+ + | template_id | String | Template ID. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | cache_mode | String | DCS instance type. The value can be: | + | | | | + | | | - **single**: single-node | + | | | | + | | | - **ha**: master/standby | + | | | | + | | | - **cluster**: Redis Cluster | + | | | | + | | | - **proxy**: Proxy Cluster | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | description | String | Description of the template. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | engine | String | Cache engine: Redis. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | engine_version | String | Cache version. | + | | | | + | | | If the cache engine is Redis, the value can be **4.0**, **5.0**, or **6.0**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | name | String | Template name. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | product_type | String | Product edition. The value can be: | + | | | | + | | | - **generic**: standard edition | + | | | | + | | | - **enterprise**: professional edition | + | | | | + | | | Enumeration values: | + | | | | + | | | - **generic** | + | | | | + | | | - **enterprise** | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | storage_type | String | Storage type. The value can be: | + | | | | + | | | - DRAM | + | | | | + | | | - SSD | + | | | | + | | | Enumeration values: | + | | | | + | | | - **DRAM** | + | | | | + | | | - **SSD** | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | type | String | Template type. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 401** + +.. table:: **Table 6** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 403** + +.. table:: **Table 7** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 404** + +.. table:: **Table 8** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 9** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error information. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum: **9** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum: **1024** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +Example Requests +---------------- + +.. code-block:: text + + GET https://{dcs_endpoint}/v2/{project_id}/config-templates?type=sys&engine=Redis&engine_version=5.0&cache_mode=ha&offset=0&limit=10 + +Example Responses +----------------- + +**Status code: 200** + +Parameter templates listed. + +.. code-block:: + + { + "template_num" : 1, + "config_templates" : [ { + "template_id" : "6", + "cache_mode" : "single", + "description" : null, + "engine" : "Redis", + "engine_version" : "4.0", + "name" : "Default-Redis-4.0-single-generic-DRAM", + "product_type" : "generic", + "storage_type" : "DRAM", + "type" : "sys" + } ] + } + +**Status code: 400** + +Invalid request. + +.. code-block:: + + { + "error_code" : "111400063", + "error_msg" : "Invalid {0} parameter in the request." + } + +Status Codes +------------ + +=========== ========================================== +Status Code Description +=========== ========================================== +200 Parameter templates listed. +400 Invalid request. +401 Invalid authentication information. +403 Request rejected. +404 The requested resource could not be found. +500 Internal service error. +=========== ========================================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index 88b4e9b..35cbb7e 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -1,512 +1,552 @@ -:original_name: dcs-api-0312044.html +:original_name: ErrorCode.html -.. _dcs-api-0312044: +.. _ErrorCode: Error Codes =========== -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Status Code | Error Code | Error Message | Description | Solution | -+=============+============+==================================================================================================================================================================+==========================================================================================================================================+========================================================================================================================================================+ -| 400 | 111400002 | Invalid project ID format. | Invalid project ID format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400004 | Empty request body. | Empty request body. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400005 | The message body contains invalid characters or is not in JSON format. | The message body contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400007 | The selected cache engine type is not supported. | The selected cache engine type is not supported. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400008 | The selected cache engine version is not supported. | The selected cache engine version is not supported. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400009 | Invalid product ID in the request. | Invalid product ID in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400010 | Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed. | Invalid DCS instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400011 | DCS instance description cannot exceed 1024 characters. | DCS instance description cannot exceed 1024 characters. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400012 | Invalid capacity parameter in the request. | Invalid capacity parameter in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400013 | Invalid vpc_id in the request. | Invalid **vpc_id** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400014 | Invalid security_group_id in the request. | Invalid **security_group_id** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400016 | Invalid subnet_id in the request. | Invalid **subnet_id** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400017 | This DCS instance job task is still running. | A background task associated with this instance is running. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400018 | This subnet must exist in the VPC. | This subnet must exist in the VPC. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400019 | The password does not meet complexity requirements. | The password does not meet complexity requirements. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400020 | DHCP must be enabled for this subnet. | DHCP must be enabled for this subnet. | Check whether DHCP has been enabled. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400021 | The isAutoRenew parameter in the request must be either 0 or 1. | Invalid **isAutoRenew** in the request. It must be either **0** or **1**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400022 | Engine does not match the product id. | The cache engine does not match the product ID. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400026 | This operation is not allowed when the DCS instance is in the current state. | This operation is not allowed when the DCS instance is in the current state. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400027 | This operation is not supported on this node. | The current node does not support this operation. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400035 | DCS instance quota of the tenant is insufficient. | DCS instance quota of the tenant is insufficient. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400036 | Memory quota of the tenant is insufficient. | Memory quota of the tenant is insufficient. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400037 | The instanceParams parameter in the request contains invalid characters or is not in JSON format. | The **instanceParams** parameter in the request contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400038 | The periodNum parameter in the request must be an integer. | The **periodNum** parameter in the request must be an integer. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400039 | The quota limit has been reached. | The quota limit has been reached. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400042 | This AZ does not exist. | This AZ does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400045 | This DCS instance is already unfrozen. | The instance is not frozen and cannot be unfrozen. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400046 | This security group does not exist. | This security group does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400047 | The periodType parameter in the request must be either 2 or 3. | The **periodType** parameter in the request must be either **2** or **3**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400048 | The security group must have both outbound and inbound rules with protocols set to ANY. | The security group must have both outbound and inbound rules with protocols set to **ANY**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400053 | the upgrade instance version equals to current version. | The **targetVersion** parameter in the request cannot be the same as the source version. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400054 | the selected available zone quota not enough. | The DCS resources in the selected AZ are not sufficient. | Select another AZ or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400060 | This DCS instance name already exists. | This instance name already exists. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400061 | Invalid instance ID format. | Invalid instance ID format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400062 | Invalid {0} parameter in the request. | Invalid parameter **{0}** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400063 | Invalid {0} parameter in the request. | Invalid parameter **{0}** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400064 | The action parameter in the request restart. | The **action** parameter in the request must be **restart**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400065 | The instances parameter in the request cannot be a null value or left unspecified. | The **instances** parameter in the request cannot be a null value or left unspecified. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400066 | Invalid value of the configure parameter {0}. | Invalid configuration parameter **{0}**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400067 | The available_zones parameter in the request must an array that contains only one AZ ID. | The **available_zones** parameter in the request must be an array that contains only one AZ ID. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400068 | This VPC does not exist. | This VPC does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400070 | Invalid task ID format. | Invalid task ID format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400072 | Invalid saveDays instance backup policy parameter in the request. | The value of the instance backup parameter **saveDays** in the request must be in the range from 1 to 7. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400073 | Invalid backupType instance backup policy parameter in the request. | The value of the instance backup parameter **backupType** in the request must be either **auto** or **manual**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400074 | Invalid periodType instance backup policy parameter in the request. | The value of the instance backup parameter **periodType** in the request must be **weekly**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400075 | Invalid backupAt instance backup policy parameter in the request. | The value of the instance backup parameter **backupAt** in the request cannot be null or undefined. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400076 | Invalid beginAt instance backup policy parameter in the request. | The value of the instance backup parameter **beginAt** in the request must be in the 00:00-00:00 format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400080 | Instance password verify failed. | Invalid password for accessing the selected DCS instance. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400086 | only master standby instance is support this action | This operation is allowed only for master/standby DCS instances. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400087 | the backup record status is err when restore this instance | The restore operation is allowed only when the backup task is in the **Succeeded** state. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400094 | the system is not support dcs job. | The system does not support the background task function. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400095 | the system is not support backup and restore. | The system does not support the backup and restoration function. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400096 | the instance is backuping. | Backing up the DCS instance... Please try again later. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400097 | the instance is restoring. | Restoring the DCS instance... Please try again later. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400098 | The value of the remark parameter must be 0 to 128 characters in length. | The value of the **remark** parameter cannot exceed 128 characters long. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400099 | DCS instances in the Creating, Restarting state cannot be deleted. | DCS instances in the **Creating** or **Restarting** state cannot be deleted. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400100 | The number of instance IDs in an instances array cannot exceed 50. | The number of instance IDs in an instances array cannot exceed 50. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400102 | The system is not support resize. | Scale-up is not supported. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400103 | The system is not support resize. | The capacity to which the DCS instance is scaled up must be greater than the original capacity. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400104 | The DCS instance is recovering from an internal fault. Please try again later or contact customer service. | The DCS instance is recovering from an internal fault. Please try again later or contact technical support. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400105 | The value of reserved-memory cannot be greater than the free memory size of this DCS instance. | The value of **reserved-memory** cannot be greater than the free memory size of this DCS instance. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400106 | The value of maintain time illegal. | Invalid maintenance time window. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400108 | The Instance exists for processing scale up order. Please try again later. | Scaling up the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400111 | the instance is restarting. | Restarting the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400113 | the instance is extending. | Scaling up the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400114 | the instance is configuring. | Modifying instance configuration... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400115 | the instance is changing the password. | Changing instance password... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400116 | the instance is upgrading. | Upgrading the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400117 | the instance is rollbacking the version. | Rolling back the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400118 | the instance is creating. | Creating the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400119 | Query Bill Sample failed | This DCS instance does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400120 | the instance is Freezing. | Freezing the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400800 | Invalid {0} in the request. | Invalid parameter **{0}** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400843 | The no_password_access parameter is missing or its value is invalid. | Parameter **no_password_access** is missing or invalid. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400844 | The access_user parameter is missing or its value is invalid. | Parameter **access_user** is missing or invalid. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400845 | The password parameter is missing or its value is invalid. | Parameter **password** is missing or invalid. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400849 | The request parameter new_password should not exist. | Request parameter **new_password** should not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | 111400850 | This operation is not supported when Password-Free Access is enabled for the instance. | This operation is not supported when password-free access is enabled for the instance. | Reset the instance password. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS. 4855 | Master standby swap is not supported. | Master/Standby switchover is not supported. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.1004 | Project ID does not match the token. | Project ID does not match the token. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4002 | Invalid project ID format. | Invalid project ID format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4004 | Empty request body. | Empty request body. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4005 | The message body contains invalid characters or is not in JSON format. | The message body contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4007 | The selected cache engine type is not supported. | The selected cache engine edition is not supported. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4008 | The selected cache engine version is not supported. | The selected cache engine version is not supported. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4009 | Invalid product ID in the request. | Invalid product ID in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4010 | Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed. | Invalid DCS instance name. The name must be 4 to 64 characters long. Only letters, digits, underscores (_), and hyphens (-) are allowed. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4011 | DCS instance description cannot exceed 1024 characters. | DCS instance description cannot exceed 1024 characters. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4012 | Invalid capacity parameter in the request. | Invalid capacity parameter in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4013 | Invalid vpc_id in the request. | Invalid **vpc_id** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4014 | Invalid security_group_id in the request. | Invalid **security_group_id** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4016 | Invalid subnet_id in the request. | Invalid **subnet_id** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4017 | This DCS instance job task is still running. | A background task associated with this instance is running. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4018 | This subnet must exist in the VPC. | This subnet must exist in the VPC. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4019 | The password does not meet complexity requirements. | The password does not meet complexity requirements. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4020 | DHCP must be enabled for this subnet. | DHCP must be enabled for this subnet. | Check whether DHCP has been enabled. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4021 | The isAutoRenew parameter in the request must be either 0 or 1. | Invalid **isAutoRenew** in the request. It must be either **0** or **1**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4022 | Engine does not match the product id. | The cache engine does not match the product ID. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4026 | This operation is not allowed when the DCS instance is in the current state. | This operation is not allowed when the DCS instance is in the current state. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4027 | This operation is not supported on this node. | The specified operation is not supported on the current node. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4035 | DCS instance quota of the tenant is insufficient. | DCS instance quota of the tenant is insufficient. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4036 | Memory quota of the tenant is insufficient. | Memory quota of the tenant is insufficient. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4037 | The instanceParams parameter in the request contains invalid characters or is not in JSON format. | The **instanceParams** parameter in the request contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4038 | The periodNum parameter in the request must be an integer. | The **periodNum** parameter in the request must be an integer. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4039 | The quota limit has been reached. | The quota limit has been reached. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4042 | This AZ does not exist. | This AZ does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4045 | This DCS instance is already unfrozen. | The instance is not frozen and cannot be unfrozen. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4046 | This security group does not exist. | The specified security group does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4047 | The periodType parameter in the request must be either 2 or 3. | The **periodType** parameter in the request must be either **2** or **3**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4048 | The security group must have both outbound and inbound rules with protocols set to ANY. | The security group must have both outbound and inbound rules with protocols set to **ANY**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4049 | The instance status is not running. | The instance status is not running. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4053 | the upgrade instance version equals to current version. | The **targetVersion** parameter in the request cannot be the same as the source version. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4054 | the selected available zone quota not enough. | The DCS resources in the selected AZ are not sufficient. | Select another AZ or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4060 | This DCS instance name already exists. | This instance name already exists. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4061 | Invalid instance ID format. | Invalid instance ID format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4062 | Invalid {0} parameter in the request. | Invalid parameter **{0}** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4063 | Invalid {0} parameter in the request. | Invalid parameter **{0}** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4064 | The action parameter in the request must be restart. | The **action** parameter in the request must be **restart**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4065 | The instances parameter in the request cannot be a null value or left unspecified. | The **instances** parameter in the request cannot be a null value or left unspecified. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4066 | Invalid value of the configure parameter {0}. | Invalid configuration parameter **{0}**. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4067 | The available_zones parameter in the request must an array that contains only one AZ ID. | The **available_zones** parameter in the request must be an array that contains only one AZ ID. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4068 | This VPC does not exist. | This VPC does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4070 | Invalid task ID format. | Invalid task ID format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4072 | Invalid saveDays instance backup policy parameter in the request. | The value of the instance backup parameter **saveDays** in the request must be in the range from 1 to 7. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4073 | Invalid backupType instance backup policy parameter in the request. | The value of the instance backup parameter **backupType** in the request must be either auto or manual. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4074 | Invalid periodType instance backup policy parameter in the request. | The value of the instance backup parameter **periodType** in the request must be weekly. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4075 | Invalid backupAt instance backup policy parameter in the request. | The value of the instance backup parameter **backupAt** in the request cannot be null or undefined. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4076 | Invalid beginAt instance backup policy parameter in the request. | The value of the instance backup parameter **beginAt** in the request must be in the 00:00-00:00 format. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4080 | Instance password verify failed. | Invalid instance password. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4086 | only master standby instance is support this action | This operation is allowed only for master/standby DCS instances. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4087 | the backup record status is err when restore this instance | The restore operation is allowed only when the backup task is in the **Succeeded** state. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4094 | the system is not support dcs job. | The system does not support the background task function. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4095 | the system is not support backup and restore. | The system does not support the backup and restoration function. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4096 | the instance is backuping. | Backing up the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4097 | the instance is restoring. | Restoring the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4098 | The value of the remark parameter must be 0 to 128 characters in length. | The value of the **remark** parameter cannot exceed 128 characters long. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4099 | DCS instances in the Creating, Restarting state cannot be deleted. | DCS instances in the **Creating** or **Restarting** state cannot be deleted. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4100 | The number of instance IDs in an instances array cannot exceed 50. | The number of instance IDs in an instances array cannot exceed 50. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4102 | The system is not support resize. | Scale-up is not supported. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4103 | The system is not support resize. | The capacity to which the DCS instance is scaled up must be greater than the original capacity. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4104 | The DCS instance is recovering from an internal fault. Please try again later or contact customer service. | The DCS instance is recovering from an internal fault. Please try again later or contact technical support. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4105 | The value of reserved-memory cannot be greater than the free memory size of this DCS instance. | The value of **reserved-memory** cannot be greater than the free memory size of this DCS instance. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4106 | The value of maintain time illegal. | Invalid maintenance time window. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4108 | The Instance exists for processing sacle up order. Please try again later. | Scaling up the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4111 | the instance is restarting. | Restarting the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4113 | the instance is extending. | Scaling up the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4114 | the instance is configuring. | Modifying instance configuration... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4115 | the instance is changing the password. | Changing instance password... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4116 | the instance is upgrading. | Upgrading the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4117 | the instance is rollbacking the version. | Rolling back the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4118 | the instance is creating. | Creating the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4119 | Query Bill Sample failed | This DCS instance does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4120 | the instance is Freezing. | Freezing the DCS instance... Please try again later. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4800 | Invalid {0} in the request. | Invalid parameter **{0}** in the request. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4843 | The no_password_access parameter is missing or its value is invalid. | Parameter **no_password_access** is missing or invalid. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4844 | The access_user parameter is missing or its value is invalid. | Parameter **access_user** is missing or invalid. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4845 | The password parameter is missing or its value is invalid. | Parameter **password** is missing or invalid. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4849 | The request parameter new_password should not exist. | Request parameter **new_password** should not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4850 | This operation is not supported when Password-Free Access is enabled for the instance. | This operation is not supported when password-free access is enabled for the instance. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4875 | Create replication number exceed max number limit. | The maximum number of replicas that can be created has been reached. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4879 | r/w instance have only one repl can not remove ip from dns | The IP address cannot be removed because a master/standby instance must have at least one replica IP address. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4911 | The network ip insufficient. | The subnet does not have sufficient IP addresses. | Check the quantity of IP addresses in the subnet. Release IP addresses that are no longer used or use another subnet that has sufficient IP addresses. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4918 | Instance bigkey analyze is running. | The big key analysis is in progress. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4919 | Does not support bigkey analyze. | Big key analysis is not supported. | Operation not allowed. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4930 | The request param node_list is invalid | Invalid **node_list** parameter in the parameter. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4931 | Node is not replica, can't delete. | The replica cannot be deleted because it is not a read-only replica. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4935 | Only one slave replication has dns ip, can not delete | The replica cannot be deleted because at least one DNS IP address must be retained. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4936 | The master node cannot be deleted | The master node cannot be deleted. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4937 | Only has one slave node,can not delete | Retain at least one replica in addition to the master. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4939 | The param slave_priority_weight is invalid. | Invalid **slave_priority_weight** parameter in the parameter. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4941 | The hotkey id does not exist. | The hot key analysis task ID does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | DCS.4942 | The bigkey id does not exist. | The big key analysis task ID does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | 111401001 | Invalid token. | Invalid token. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | 111401002 | Token expired. | The token has expired. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | 111401003 | No token in the request. | The token is missing. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | 111401004 | Project ID does not match the token. | Project ID does not match the token. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | DCS.1001 | Invalid token. | Invalid token. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | DCS.1002 | Token expired. | The token has expired. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | DCS.1003 | No token in the request. | The token is missing. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | DCS.1004 | Project ID does not match the token. | Project ID does not match the token. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | 111403002 | This tenant has read permission only and cannot perform this operation. | This tenant has read permissions only and cannot perform this operation. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | 111403003 | This role does not have the permission to perform this operation. | This role does not have the permissions to perform this operation. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | DCS.2007 | Policy does not allow {} to be performed. | Insufficient permissions. | Check whether the account has the required operation permissions. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | DCS.3002 | This tenant has read permission only and cannot perform this operation. | This tenant has read permissions only and cannot perform this operation. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | DCS.3003 | This role does not have the permission to perform this operation. | This role does not have the permissions to perform this operation. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | 111404001 | The requested URL does not exist. | The requested URL does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | 111404022 | This DCS instance does not exist. | This DCS instance does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | 111404023 | This DCS order does not exist. | The order does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | DCS.4001 | The requested URL does not exist. | The requested URL does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | DCS.4022 | This DCS instance does not exist. | This DCS instance does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | DCS.4023 | This DCS order does not exist. | The order does not exist. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | 111405001 | This request method is not allowed. | The request method is not allowed. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | DCS.5001 | This request method is not allowed. | The request method is not allowed. | Check whether the request parameters are valid. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111400069 | Another user is modifying configuration parameters of the DCS instance. Please try again later. | Another user is modifying configuration parameters of the DCS instance. Try again later. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111400101 | Delete instance backup file failed. | Failed to delete the instance backup files. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111400842 | job execution status failed. | Failed to run the task. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500000 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500006 | Failed to submit Job for background execution. | Failed to submit Job for background execution. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500017 | Failed to save instance information. | Failed to save instance information. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500020 | vm add port fail | A port fails to be added for the VM. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500024 | Query instance failed. | The instance fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500031 | create instance fail | Failed to create the DCS instance. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500032 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500037 | query order info fail | Failed to query the order details. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500041 | No resource tenant available. | No resource tenant available. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500044 | update resource status fail | Failed to update the status of the DCS instance. | Try again later or contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500053 | No instance node found. | No instance node found. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500054 | Generate a password error. | Failed to generate a password. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500070 | Internal service error. | Parameter modification failed. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500071 | Failed to create instance backup strategy. | The instance backup policy fails to be created. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500077 | Query instance backup strategy failed. | The instance backup policy fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500078 | Query backup record failed. | The backup record fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500079 | Query restore record failed. | The restoration record fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500082 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500083 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500085 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500090 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500092 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | 111500104 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS. 5094 | Master standby swap failed. | Master/Standby switchover failed. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.4069 | Another user is modifying configuration parameters of the DCS instance. Please try again later. | Another user is modifying configuration parameters of the DCS instance. Try again later. | Try again later. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.4101 | Delete instance backup file failed. | Failed to delete the instance backup files. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.4842 | job execution status failed. | Failed to run the task. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5000 | The system is busy. Please try again later. | System busy. Try again later. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5006 | Job submit failed | Failed to submit the task. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5006 | Submit job failed. | Failed to submit the task. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5017 | Failed to save instance information. | Failed to save the instance information. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5020 | vm add port fail | A port fails to be added for the VM. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5024 | Query instance failed. | The instance fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5031 | create instance fail | Failed to create the DCS instance. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5032 | Failed to create order. | Failed to create the order number. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5037 | query order info fail | Failed to query the order details. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5041 | No resource tenant available. | No resource tenant available. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5044 | update resource status fail | Failed to update the status of the DCS instance. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5053 | Instance node not found. | The specified instance node is not found. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5054 | Failed to generate password. | The password fails to be generated. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5070 | Internal service error. | Internal service error. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5071 | Failed to create instance backup strategy. | The instance backup policy fails to be created. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5077 | Query instance backup strategy failed | The instance backup policy fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5077 | Query instance failed. | The instance fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5078 | Query backup record failed. | The backup record fails to be queried. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5079 | Query group node failed. | Failed to query the node. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5081 | Query instance group information failed. | Failed to query the instance shard information. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5082 | Failed to register resource tenant backup user. | The resource tenant backup user fails to be registered. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5083 | Failed to save backup user. | The backup user fails to be saved. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5085 | Query instance whitelist failed. | Failed to query the instance whitelist. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5090 | Failed to save backup information. | The backup information fails to be saved. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5091 | Do not support create small spec instance. | Small-specification instances cannot be created. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5092 | Failed to get master node. | The master node of a master/standby instance cannot be found. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5095 | The script execution failed and needs to be retried. | The script fails to be executed and needs to be executed again. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | DCS.5104 | Failed to modify order. | Failed to modify the order. | Contact technical support. | -+-------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Status Code | Error Codes | Error Message | Description | Solution | ++=============+=============+==================================================================================================================================================================+==================================================================================================================================================================+=========================================================================================================================================================+ +| 400 | 111400002 | Invalid project ID format. | Invalid project ID format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400004 | Empty request body. | Empty request body. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400005 | The message body contains invalid characters or is not in JSON format. | The message body contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400007 | The selected cache engine type is not supported. | The selected cache engine type is not supported. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400008 | The selected cache engine version is not supported. | The selected cache engine version is not supported. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400009 | Invalid product ID in the request. | Invalid product ID in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400010 | Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed. | Invalid instance name. The name can contain 4 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400011 | DCS instance description cannot exceed 1024 characters. | DCS instance description cannot exceed 1024 characters. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400012 | Invalid capacity parameter in the request. | Invalid capacity parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400013 | Invalid vpc_id in the request. | Invalid vpc_id in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400014 | Invalid security_group_id in the request. | Invalid security_group_id in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400016 | Invalid subnet_id in the request. | Invalid subnet_id in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400017 | This DCS instance job task is still running. | This DCS instance job task is still running. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400018 | This subnet must exist in the VPC. | This subnet must exist in the VPC. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400019 | The password does not meet complexity requirements. | The password does not meet complexity requirements. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400020 | DHCP must be enabled for this subnet. | DHCP must be enabled for this subnet. | Check whether DHCP has been enabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400021 | The isAutoRenew parameter in the request must be either 0 or 1. | The isAutoRenew parameter in the request must be either 0 or 1. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400022 | Engine does not match the product id. | The cache engine does not match the product ID. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400026 | This operation is not allowed when the DCS instance is in the current state. | This operation is not allowed when the DCS instance is in the current state. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400027 | This operation is not supported on this node. | This operation is not supported on this node. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400035 | DCS instance quota of the tenant is insufficient. | DCS instance quota of the tenant is insufficient. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400036 | Memory quota of the tenant is insufficient. | Memory quota of the tenant is insufficient. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400037 | The instanceParams parameter in the request contains invalid characters or is not in JSON format. | The instanceParams parameter in the request contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400038 | The periodNum parameter in the request must be an integer. | The periodNum parameter in the request must be an integer. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400039 | The quota limit has been reached. | The quota limit has been reached. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400042 | This AZ does not exist. | This AZ does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400045 | This DCS instance is already unfrozen. | This DCS instance is already unfrozen. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400046 | This security group does not exist. | This security group does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400047 | The periodType parameter in the request must be either 2 or 3. | The periodType parameter in the request must be either 2 or 3. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400048 | The security group must have both outbound and inbound rules with protocols set to ANY. | The security group must have both outbound and inbound rules with protocols set to ANY. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400053 | the upgrade instance version equals to current version. | The targetVersion parameter in the request cannot be the same as the source version. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400054 | the selected available zone quota not enough. | DCS resources in the selected AZ have been sold out. | Select another AZ or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400060 | This DCS instance name already exists. | This DCS instance name already exists. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400061 | Invalid instance ID format. | Invalid instance ID format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400062 | Invalid {0} parameter in the request. | Invalid {0} parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400063 | Invalid {0} parameter in the request. | Invalid {0} parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400064 | The action parameter in the request must be start, stop, or restart. | The action parameter in the request must be start, stop, or restart. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400065 | The instances parameter in the request cannot be a null value or left unspecified. | The instances parameter in the request cannot be a null value or left unspecified. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400066 | Invalid value of the configure parameter {0}. | Invalid value of the configure parameter {0}. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400067 | The available_zones parameter in the request must an array that contains only one AZ ID. | The available_zones parameter in the request must an array that contains only one AZ ID. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400068 | This VPC does not exist. | This VPC does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400070 | Invalid task ID format. | Invalid task ID format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400072 | Invalid saveDays instance backup policy parameter in the request. | Invalid saveDays instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400073 | Invalid backupType instance backup policy parameter in the request. | Invalid backupType instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400074 | Invalid periodType instance backup policy parameter in the request. | Invalid periodType instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400075 | Invalid backupAt instance backup policy parameter in the request. | Invalid backupAt instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400076 | Invalid beginAt instance backup policy parameter in the request. | Invalid beginAt instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400080 | Instance password verify failed. | Instance password verify failed. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400086 | only master standby instance is support this action | This operation is allowed only for master/standby instances. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400087 | the backup record status is err when restore this instance | The restoration operation is allowed only when the backup task succeeded. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400094 | the system is not support dcs job. | The system does not support the background task function. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400095 | the system is not support backup and restore. | The system does not support the backup and restoration function. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400096 | the instance is backuping. | Backing up the instance... Please try again later. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400097 | the instance is restoring. | Restoring the instance... Please try again later. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400098 | The value of the remark parameter must be 0 to 128 characters in length. | The value of the remark parameter must be 0 to 128 characters in length. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400099 | DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted. | DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400100 | The number of instance IDs in an instances array cannot exceed 50. | The number of instance IDs in an instances array cannot exceed 50. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400102 | The system is not support resize. | Scale-up is not supported. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400103 | The system is not support resize. | The capacity to which the instance is scaled up must be greater than the original capacity. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400104 | The DCS instance is recovering from an internal fault. Please try again later or contact customer service. | The DCS instance is recovering from an internal fault. Please try again later or contact customer service. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400105 | The value of reserved-memory cannot be greater than the free memory size of this DCS instance. | The value of reserved-memory cannot be greater than the free memory size of this DCS instance. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400106 | The value of maintain time illegal. | Invalid maintenance time window. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400107 | The instance exists for unpaid sacle up orders. Please process non payment orders first. | This instance has unpaid scale-up orders. Please process the orders before continuing. | Process unpaid orders before continuing. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400108 | The Instance exists for processing sacle up order. Please try again later. | Scaling up the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400111 | the instance is restarting. | Restarting the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400113 | the instance is extending. | Scaling up the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400114 | the instance is configuring. | Modifying instance configuration... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400115 | the instance is changing the password. | The password is being changed. Try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400116 | the instance is upgrading. | Upgrading the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400117 | the instance is rollbacking the version. | Rolling back the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400118 | the instance is creating. | Creating the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400119 | Query Bill Sample failed | The instance does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400120 | the instance is Freezing. | Freezing the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400800 | Invalid {0} in the request. | Invalid {0} in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400843 | The no_password_access parameter is missing or its value is invalid. | The no_password_access parameter is missing or its value is invalid. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400844 | The access_user parameter is missing or its value is invalid. | The access_user parameter is missing or its value is invalid. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400845 | The password parameter is missing or its value is invalid. | The password parameter is missing or its value is invalid. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400849 | The request parameter new_password should not exist. | The request parameter new_password should not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | 111400850 | This operation is not supported when Password-Free Access is enabled for the instance. | This operation is not supported when Password-Free Access is enabled for the instance. | Reset the instance password. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS. 4855 | Master standby swap is not supported. | Master/standby switchover is not supported. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4002 | Invalid project ID format. | Invalid project ID format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4004 | Empty request body. | Empty request body. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4005 | The message body contains invalid characters or is not in JSON format. | The message body contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4006 | The selected cache engine type is not supported. | The selected cache engine type is not supported. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4007 | Instance type is not supported. | Instance type is not supported. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4008 | The selected cache engine version is not supported. | The selected cache engine version is not supported. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4009 | Invalid product ID in the request. | Invalid product ID in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4010 | Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed. | Invalid DCS instance name. The name must be 4 to 64 characters in length. Only letters (case-insensitive), digits, underscores (_) ,and hyphens (-) are allowed. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4011 | DCS instance description cannot exceed 1024 characters. | DCS instance description cannot exceed 1024 characters. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4012 | Invalid capacity parameter in the request. | Invalid capacity parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4013 | Invalid vpc_id in the request. | Invalid vpc_id in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4014 | Invalid security_group_id in the request. | Invalid security_group_id in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4016 | Invalid subnet_id in the request. | Invalid subnet_id in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4017 | This DCS instance job task is still running. | This DCS instance job task is still running. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4018 | This subnet must exist in the VPC. | This subnet must exist in the VPC. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4019 | The password does not meet complexity requirements. | The password does not meet complexity requirements. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4020 | DHCP must be enabled for this subnet. | DHCP must be enabled for this subnet. | Check whether DHCP has been enabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4021 | The isAutoRenew parameter in the request must be either 0 or 1. | The isAutoRenew parameter in the request must be either 0 or 1. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4022 | Engine does not match the product id. | The cache engine does not match the product ID. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4026 | This operation is not allowed when the DCS instance is in the current state. | This operation is not allowed when the DCS instance is in the current state. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4027 | This operation is not supported on this node. | This operation is not supported on this node. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4035 | DCS instance quota of the tenant is insufficient. | DCS instance quota of the tenant is insufficient. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4036 | Memory quota of the tenant is insufficient. | Memory quota of the tenant is insufficient. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4037 | The instanceParams parameter in the request contains invalid characters or is not in JSON format. | The instanceParams parameter in the request contains invalid characters or is not in JSON format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4038 | The periodNum parameter in the request must be an integer. | The periodNum parameter in the request must be an integer. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4039 | The quota limit has been reached. | The quota limit has been reached. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4042 | This AZ does not exist. | This AZ does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4045 | This DCS instance is already unfrozen. | This DCS instance is already unfrozen. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4046 | This security group does not exist. | This security group does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4047 | The periodType parameter in the request must be either 2 or 3. | The periodType parameter in the request must be either 2 or 3. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4048 | The security group must have both outbound and inbound rules with protocols set to ANY. | The security group must have both outbound and inbound rules with protocols set to ANY. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4049 | The instance status is not running. | The instance status is not running. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4053 | the upgrade instance version equals to current version. | The targetVersion parameter in the request cannot be the same as the source version. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4054 | the selected available zone quota not enough. | DCS resources in the selected AZ have been sold out. | Select another AZ or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4060 | This DCS instance name already exists. | This DCS instance name already exists. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4061 | Invalid instance ID format. | Invalid instance ID format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4062 | Invalid {0} parameter in the request. | Invalid {0} parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4063 | Invalid {0} parameter in the request. | Invalid {0} parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4064 | The action parameter in the request must be start, stop, or restart. | The action parameter in the request must be start, stop, or restart. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4065 | The instances parameter in the request cannot be a null value or left unspecified. | The instances parameter in the request cannot be a null value or left unspecified. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4066 | Invalid value of the configure parameter {0}. | Invalid value of the configure parameter {0}. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4067 | The available_zones parameter in the request must an array that contains only one AZ ID. | The available_zones parameter in the request must an array that contains only one AZ ID. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4068 | This VPC does not exist. | This VPC does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4070 | Invalid task ID format. | Invalid task ID format. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4072 | Invalid saveDays instance backup policy parameter in the request. | Invalid saveDays instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4073 | Invalid backupType instance backup policy parameter in the request. | Invalid backupType instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4074 | Invalid periodType instance backup policy parameter in the request. | Invalid periodType instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4075 | Invalid backupAt instance backup policy parameter in the request. | Invalid backupAt instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4076 | Invalid beginAt instance backup policy parameter in the request. | Invalid beginAt instance backup policy parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4080 | Instance password verify failed. | Instance password verify failed. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4086 | only master standby instance is support this action | This operation is allowed only for master/standby instances. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4087 | the backup record status is err when restore this instance | The restoration operation is allowed only when the backup task succeeded. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4094 | the system is not support dcs job. | The system does not support the background task function. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4095 | the system is not support backup and restore. | The system does not support the backup and restoration function. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4096 | the instance is backuping. | Backing up the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4097 | the instance is restoring. | Restoring the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4098 | The value of the remark parameter must be 0 to 128 characters in length. | The value of the remark parameter must be 0 to 128 characters in length. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4099 | DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted. | DCS instances in the Creating, Starting, Stopping, or Restarting state cannot be deleted. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4100 | The number of instance IDs in an instances array cannot exceed 50. | The number of instance IDs in an instances array cannot exceed 50. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4102 | The system is not support resize. | The system is not support resize. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4103 | The system is not support resize. | The system is not support resize. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4104 | The DCS instance is recovering from an internal fault. Please try again later or contact customer service. | The DCS instance is recovering from an internal fault. Please try again later or contact customer service. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4105 | The value of reserved-memory cannot be greater than the free memory size of this DCS instance. | The value of reserved-memory cannot be greater than the free memory size of this DCS instance. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4106 | The value of maintain time illegal. | The value of maintain time illegal. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4107 | The instance exists for unpaid sacle up orders. Please process non payment orders first. | The instance exists for unpaid sacle up orders. Please process non payment orders first. | Process unpaid orders before continuing. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4108 | The Instance exists for processing sacle up order. Please try again later. | The Instance exists for processing sacle up order. Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4111 | the instance is restarting. | Restarting the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4113 | the instance is extending. | Scaling up the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4114 | the instance is configuring. | Modifying instance configuration... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4115 | the instance is changing the password. | The password is being changed. Try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4116 | the instance is upgrading. | Upgrading the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4117 | the instance is rollbacking the version. | Rolling back the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4118 | the instance is creating. | Creating the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4119 | Query Bill Sample failed | The instance does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4120 | the instance is Freezing. | Freezing the instance... Please try again later. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4253 | All replicas have a priority of 0. | All replicas have a priority of 0. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4300 | Client IP transparent transmission is being processed, please do not submit it repeatedly. | Client IP transparent transmission is being processed, please do not submit it repeatedly. | Client IP pass-through is being enabled or disabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4800 | Invalid {0} in the request. | Invalid {0} in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4819 | The first_scan_at parameter is invalid. Its must be ISO format utc date-time. The time must be later than the current time. | first_scan_at must be ISO format utc date-time. The time must be later than the current time. | Check whether the request parameters are valid. Example of the ISO UTC format: "2021-08-18T07:33:00.000Z" | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4820 | The interval parameter is invalid. must Greater than or equal to 0. | The value of interval is invalid. It must be greater than or equal to 0 seconds. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4821 | The timeout parameter is invalid. Its must Greater than or equal to interval \* 2, if interval is 0, timeout must Greater than 1 second. | The value of the timeout parameter is invalid. The value must be greater than 0 and at least twice the scanning interval. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4822 | The scan_keys_count parameter is invalid. Its must Greater than or equal to 10, and Less than or equal to 1000. | The value of the scan_keys_count parameter is invalid. The value range is from 10 to 1000. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4838 | Do not support feature client ip transparent transmission. | Client IP pass-through is not supported. | Client IP pass-through is not enabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4839 | Do not support feature public dns. | Public domain name resolution is not supported. | Public domain name resolution is not enabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4840 | Do not support feature dns. | Domain name resolution is not supported. | Domain name resolution is disabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4841 | Instance do not support client ip transparent transmission. | The instance does not support client IP pass-through. | The instance version does not support client IP pass-through. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4843 | The no_password_access parameter is missing or its value is invalid. | The no_password_access parameter is missing or its value is invalid. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4844 | The access_user parameter is missing or its value is invalid. | The access_user parameter is missing or its value is invalid. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4845 | The password parameter is missing or its value is invalid. | The password parameter is missing or its value is invalid. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4846 | Client ip transparent transmission is already closed,please do not repeat the operation. | Client IP pass-through is already disabled. | Client IP pass-through is disabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4847 | Client ip transparent transmission is already opened,please do not repeat the operation. | Client IP pass-through is already enabled. | Client IP pass-through is enabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4848 | Client Management is not supported. | Session management is not supported. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4849 | The request parameter new_password should not exist. | The request parameter new_password should not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4850 | This operation is not supported when Password-Free Access is enabled for the instance. | This operation is not supported when Password-Free Access is enabled for the instance. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4857 | DCS instances cannot be deleted if they are billed on a yearly/monthly basis. | DCS instances cannot be deleted if they are billed on a yearly/monthly basis. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4875 | Create replication number exceed max number limit. | The maximum number of replicas that can be created has been reached. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4879 | r/w instance have only one repl can not remove ip from dns | The IP address cannot be removed because a master/standby instance must have at least one replica IP address. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4911 | The network ip insufficient. | The subnet does not have sufficient IP addresses. | Check the quantity of IP addresses in the subnet. Release IP addresses that are no longer used, or use another subnet that has sufficient IP addresses. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4918 | Instance bigkey analyze is running. | The big key analysis is in progress. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4919 | Does not support bigkey analyze. | Big key analysis is not supported. | Operation not allowed. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4930 | The request param node_list is invalid | Invalid node_list parameter in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4931 | Node is not replica, can't delete. | The replica cannot be deleted because it is not a read-only replica. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4935 | Only one slave replication has dns ip, can not delete | The replica cannot be deleted because at least one DNS IP address must be retained. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4936 | The master node cannot be deleted | The master node cannot be deleted. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4937 | Only has one slave node,can not delete | Retain at least one replica in addition to the master. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4939 | The param slave_priority_weight is invalid. | Invalid slave_priority_weight parameter in the parameter. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4941 | The hotkey id does not exist. | The hot key analysis task ID does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4942 | The bigkey id does not exist. | The big key analysis task ID does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4957 | This operation is not allowed when the task is in the current state. | This operation is not allowed when the task is in the current state. | Only tasks in the successful state support this operation. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4998 | Domain names are up to date. | The domain name has already been updated. | The domain name has already been updated. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 400 | DCS.4999 | Do not support feature update domain name. | Domain name update is not supported. | Domain name optimization is not enabled. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | 111401001 | Invalid token. | Invalid token. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | 111401002 | Token expired. | Token expired. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | 111401003 | No token in the request. | No token in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | 111401004 | Project ID does not match the token. | Project ID does not match the token. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | DCS.1001 | Invalid token. | Invalid token. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | DCS.1002 | Token expired. | Token expired. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | DCS.1003 | No token in the request. | No token in the request. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 401 | DCS.1004 | Project ID does not match the token. | Project ID does not match the token. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | 111403002 | This tenant has read permission only and cannot perform this operation. | This tenant has read permission only and cannot perform this operation. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | 111403003 | This role does not have the permission to perform this operation. | This role does not have the permission to perform this operation. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | DCS.2003 | This role does not have the permission to perform this operation. | This role does not have the permission to perform this operation. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | DCS.2007 | Policy does not allow {} to be performed. | Insufficient permissions. | Check whether the account has the required operation permissions. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | DCS.3002 | This tenant has read permission only and cannot perform this operation. | This tenant has read permission only and cannot perform this operation. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 403 | DCS.3003 | This role does not have the permission to perform this operation. | This role does not have the permission to perform this operation. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | 111404001 | The requested URL does not exist. | The requested URL does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | 111404022 | This DCS instance does not exist. | This DCS instance does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | 111404023 | This DCS order does not exist. | This DCS order does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | DCS.3022 | This DCS instance does not exist. | This DCS instance does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | DCS.4001 | The requested URL does not exist. | The requested URL does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 404 | DCS.4023 | This DCS order does not exist. | This DCS order does not exist. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 405 | 111405001 | This request method is not allowed. | This request method is not allowed. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 405 | DCS.5001 | This request method is not allowed. | This request method is not allowed. | Check whether the request parameters are valid. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111400069 | Another user is modifying configuration parameters of the DCS instance. Please try again later. | Another user is modifying configuration parameters of the DCS instance. Please try again later. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111400101 | Delete instance backup file failed. | The instance backup file fails to be deleted. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111400842 | job execution status failed. | Failed to run the task. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500000 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500006 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500017 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500020 | vm add port fail | Failed to add a port for the VM. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500024 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500031 | create instance fail | Failed to create a DCS instance. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500032 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500037 | query order info fail | query order info fail | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500041 | No resource tenant available. | No resource tenant available. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500044 | update resource status fail | Failed to update the status of the instance. | Try again later or contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500053 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500054 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500070 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500071 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500077 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500078 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500079 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500082 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500083 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500085 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500090 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500091 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500092 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500095 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | 111500104 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS. 5094 | Master standby swap failed. | Master/standby switchover failed. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.4069 | Another user is modifying configuration parameters of the DCS instance. Please try again later. | Another user is modifying configuration parameters of the DCS instance. Please try again later. | Try again later. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.4101 | Delete instance backup file failed. | The instance backup file fails to be deleted. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.4842 | job execution status failed. | Failed to run the task. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5000 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5006 | Submit job failed. | Submission failed. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5017 | Failed to save instance information. | Failed to save the instance information. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5020 | vm add port fail | Failed to add a port for the VM. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5024 | Query instance failed. | Failed to query the instance. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5031 | create instance fail | Failed to create a DCS instance. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5032 | Failed to create order. | Failed to create the order. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5037 | query order info fail | Failed to query the order details. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5041 | No resource tenant available. | No resource tenant available. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5044 | update resource status fail | Failed to update the status of the instance. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5053 | Instance node not found. | Instance node not found. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5054 | Failed to generate password. | Failed to generate a password. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5070 | Internal service error. | Internal service error. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5071 | Failed to create instance backup strategy. | Failed to create the instance backup policy. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5077 | Query instance failed. | Failed to query the instance backup policy. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5078 | Query backup record failed. | Failed to query the backup record. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5079 | Query restore record failed. | Failed to query the restoration record. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5081 | The resource tenant does not exist. | The resource tenant does not exist. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5082 | Failed to register resource tenant backup user. | Failed to register the resource tenant backup user. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5083 | Failed to save backup user. | The backup user fails to be saved. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5085 | Failed to update backup strategy. | The backup policy fails to be updated. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5090 | Failed to save backup information. | The backup information fails to be saved. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5091 | Script execution failed. | Script execution failed. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5092 | Failed to save and restore data. | Failed to save and restore data. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5095 | The script execution failed and needs to be retried. | Script execution failed and needs to be retried. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 500 | DCS.5104 | Failed to modify order. | Failed to modify the order. | Contact technical support. | ++-------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst index 5483bd1..db665df 100644 --- a/api-ref/source/appendix/index.rst +++ b/api-ref/source/appendix/index.rst @@ -6,9 +6,10 @@ Appendix ======== - :ref:`Status Codes ` -- :ref:`Error Codes ` +- :ref:`Error Codes ` - :ref:`Obtaining a Project ID ` - :ref:`DCS Instance Statuses ` +- :ref:`Instance Diagnosis IDs ` .. toctree:: :maxdepth: 1 @@ -18,3 +19,4 @@ Appendix error_codes obtaining_a_project_id dcs_instance_statuses + instance_diagnosis_ids diff --git a/api-ref/source/appendix/instance_diagnosis_ids.rst b/api-ref/source/appendix/instance_diagnosis_ids.rst new file mode 100644 index 0000000..3ca491f --- /dev/null +++ b/api-ref/source/appendix/instance_diagnosis_ids.rst @@ -0,0 +1,71 @@ +:original_name: dcs-api-0312050.html + +.. _dcs-api-0312050: + +Instance Diagnosis IDs +====================== + +.. table:: **Table 1** cause_ids + + +----+-------+---------------------------------------------------------------------------+ + | ID | Type | Description | + +====+=======+===========================================================================+ + | 1 | cause | The number of connected clients exceeds {THRESHOLD}. | + +----+-------+---------------------------------------------------------------------------+ + | 2 | cause | The instantaneous traffic is too high. | + +----+-------+---------------------------------------------------------------------------+ + | 3 | cause | The underlying disk is abnormal. | + +----+-------+---------------------------------------------------------------------------+ + | 4 | cause | Data persistence failed. | + +----+-------+---------------------------------------------------------------------------+ + | 5 | cause | Memory usage exceeds {THRESHOLD}. | + +----+-------+---------------------------------------------------------------------------+ + | 6 | cause | RDB persistence is enabled. Memory usage exceeds {THRESHOLD}. | + +----+-------+---------------------------------------------------------------------------+ + | 7 | cause | Excessive memory fragmentation. | + +----+-------+---------------------------------------------------------------------------+ + | 8 | cause | Cache hit rate is lower than {THRESHOLD}. | + +----+-------+---------------------------------------------------------------------------+ + | 9 | cause | Too many keys have expired at the same time. | + +----+-------+---------------------------------------------------------------------------+ + | 10 | cause | The following commands with time complexity O(N) are executed: {COMMANDS} | + +----+-------+---------------------------------------------------------------------------+ + | 11 | cause | CPU usage exceeds {THRESHOLD}. | + +----+-------+---------------------------------------------------------------------------+ + | 12 | cause | Data is persisted. | + +----+-------+---------------------------------------------------------------------------+ + | 13 | cause | QPS has increased. | + +----+-------+---------------------------------------------------------------------------+ + +.. table:: **Table 2** impact_ids + + == ====== ================================== + ID Type Description + == ====== ================================== + 1 impact Redis connections will be refused. + 2 impact Redis will be disconnected. + 3 impact Redis responses will slow down. + 4 impact RDB persistence will fail. + 5 impact Cache hit ratio will decrease. + 6 impact AOF persistence will fail. + == ====== ================================== + +.. table:: **Table 3** advice_ids + + +----+--------+---------------------------------------------------------------------------------+ + | ID | Type | Description | + +====+========+=================================================================================+ + | 1 | advice | Retrieve connections from the connection pool. | + +----+--------+---------------------------------------------------------------------------------+ + | 2 | advice | Use read/write splitting or a cluster. | + +----+--------+---------------------------------------------------------------------------------+ + | 3 | advice | Expand the capacity of the instance. | + +----+--------+---------------------------------------------------------------------------------+ + | 4 | advice | Manually run the **MEMORY PURGE** command during low-demand hours. | + +----+--------+---------------------------------------------------------------------------------+ + | 5 | advice | Check the Redis usage or reduce the cache granularity to avoid memory eviction. | + +----+--------+---------------------------------------------------------------------------------+ + | 6 | advice | Set different expiration time for the keys. | + +----+--------+---------------------------------------------------------------------------------+ + | 7 | advice | Do not use commands with time complexity of O(N). | + +----+--------+---------------------------------------------------------------------------------+ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 7a61dd9..b04c553 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -10,16 +10,27 @@ Change History +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | What's New | +===================================+====================================================================================================================================================================================================================================================================================================================================+ + | 2023-01-17 | - Added :ref:`API V2 ` and :ref:`Instance Diagnosis IDs `. | + | | - Updated section "Error Codes." | + | | - Moved out-of-date APIs to :ref:`Outdated APIs (V1) `. | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2022-12-13 | Modified the following content: | + | | | + | | - In section :ref:`Querying All DCS Instances of a Tenant `, added the **include_failure** parameter and deleted the **isExactMatchName** parameter. | + | | - In section :ref:`Querying DCS Instance Status `, added parameters such as **redis**, and changed the **includeFailure** parameter to **include_failure**. | + | | - Updated the example request format in section :ref:`Deleting Backup Files `. | + | | - In section :ref:`Querying AZ Information `, changed the **regionID** parameter to **region_id**. | + +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 `. | - | | - Deleted the **includeFailure** parameter from :ref:`Querying All DCS Instances of a Tenant `. | + | | - In section :ref:`Querying All DCS Instances of a Tenant `, deleted the **includeFailure** parameter. | | | - Modified the description of the **maxmemory-policy** parameter in :ref:`Parameter Management APIs `. | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2022-08-04 | Modified the following content: | | | | | | - Optimized parameter description in :ref:`Creating a DCS Instance ` and :ref:`Querying All DCS Instances of a Tenant `. | - | | - Added sections :ref:`Configuring IP Whitelist Groups ` and :ref:`Querying the IP Whitelist of a DCS Instance `. | + | | - Added sections "Configuring IP Whitelist Groups" and "Querying the IP Whitelist of a DCS Instance." | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2022-07-13 | Modified the following content: | | | | @@ -50,11 +61,11 @@ Change History | | | | | - 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 `. | - | | - Optimized :ref:`Error Codes `. | + | | - Optimized section "Error Code." | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2020-06-16 | Modified the following content: | | | | - | | Added error codes such as 111400102 in section :ref:`Error Codes `. | + | | Added error codes such as 111400102 in the **Error Codes** section. | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2020-03-25 | Modified the following content: | | | | @@ -89,11 +100,11 @@ Change History | | | | | Added the following content: | | | | - | | - Added sections :ref:`Scaling Up a DCS Instance `. | + | | - Added section :ref:`Scaling Up a DCS Instance `. | | | - Added sections :ref:`Backing Up a DCS Instance ` to :ref:`Deleting Backup Files `. | | | - Added the **Time Window** parameter. | | | - Added two Redis parameters **maxclients** and **reserved-memory** in section :ref:`Querying Configuration Parameters `. | - | | - Added some error codes and their description in chapter :ref:`Error Codes `. | + | | - Added some error codes and their description in chapter "Error Codes." | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2017-05-30 | Modified the following content: | | | | diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 9467c28..8b60509 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -6,12 +6,7 @@ Distributed Cache Service - API Reference :maxdepth: 1 api_usage_guidelines - lifecycle_management_apis/index - instance_management_apis/index - parameter_management_apis/index - data_migration_apis/index - backup_and_restoration_apis/index - network_security/index - other_apis/index + api_v2/index + outdated_apis_v1/index appendix/index change_history diff --git a/api-ref/source/instance_management_apis/querying_dcs_instance_status.rst b/api-ref/source/instance_management_apis/querying_dcs_instance_status.rst deleted file mode 100644 index db9c29c..0000000 --- a/api-ref/source/instance_management_apis/querying_dcs_instance_status.rst +++ /dev/null @@ -1,158 +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 ` 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 ` 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. | - +--------------------+---------+----------------------------------------------------------------+ - | upgrading_count | Integer | Number of instances that are being upgraded. | - +--------------------+---------+----------------------------------------------------------------+ - | paying_count | Integer | Number of instances for which payment is in progress. | - +--------------------+---------+----------------------------------------------------------------+ - | migrating_count | Integer | Number of instances on which data migration is in progress. | - +--------------------+---------+----------------------------------------------------------------+ - | flushing_count | Integer | Number of instances whose data is being cleared. | - +--------------------+---------+----------------------------------------------------------------+ - | closed_count | Integer | Number of instances that have been stopped. | - +--------------------+---------+----------------------------------------------------------------+ - | starting_count | Integer | Number of instances that are being started. | - +--------------------+---------+----------------------------------------------------------------+ - | closing_count | Integer | Number of instances that are being stopped. | - +--------------------+---------+----------------------------------------------------------------+ - | restoring_count | Integer | Number of instances for which data restoration is in progress. | - +--------------------+---------+----------------------------------------------------------------+ - -**Example response** - -.. code-block:: - - {"memcached":{ - "paying_count":0, - "migrating_count":0, - "error_count":0, - "restarting_count":0, - "createfailed_count":0, - "flushing_count":0, - "closed_count":0, - "extending_count":0, - "creating_count":0, - "starting_count":0, - "closing_count":0, - "running_count":0, - "upgrading_count":0, - "restoring_count":0 - }, - "paying_count":0, - "migrating_count":0, - "error_count":0, - "restarting_count":0, - "createfailed_count":0, - "flushing_count":0, - "redis":{ - "paying_count":0, - "migrating_count":0, - "error_count":0, - "restarting_count":0, - "createfailed_count":0, - "flushing_count":0, - "closed_count":0, - "extending_count":2, - "creating_count":0, - "starting_count":0, - "closing_count":0, - "running_count":1, - "upgrading_count":0, - "restoring_count":0 - }, - "closed_count":0, - "extending_count":2, - "creating_count":0, - "starting_count":0, - "closing_count":0, - "running_count":1, - "upgrading_count":0, - "restoring_count":0} - } - -Status Code ------------ - -:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. - -.. _dcs-api-0312016__table36591653133: - -.. table:: **Table 3** Status code - - +-------------+-------------------------------------------------------------------------+ - | Status Code | Description | - +=============+=========================================================================+ - | 200 | Quantities of DCS instances in different statuses queried successfully. | - +-------------+-------------------------------------------------------------------------+ diff --git a/api-ref/source/backup_and_restoration_apis/backing_up_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/backing_up_a_dcs_instance.rst similarity index 71% rename from api-ref/source/backup_and_restoration_apis/backing_up_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/backup_and_restoration_apis/backing_up_a_dcs_instance.rst index 6bd4a06..ce48799 100644 --- a/api-ref/source/backup_and_restoration_apis/backing_up_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/backing_up_a_dcs_instance.rst @@ -19,9 +19,9 @@ URI POST /v1.0/{project_id}/instances/{instance_id}/backups -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312020__table1899262913382: +.. _dcs-api-0312020__en-us_topic_0166889614_table1899262913382: .. table:: **Table 1** Parameter description @@ -37,9 +37,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312020__table153111335113816: +.. _dcs-api-0312020__en-us_topic_0166889614_table153111335113816: .. table:: **Table 2** Parameter description @@ -70,9 +70,9 @@ Response **Response parameters** -:ref:`Table 3 ` describes the response parameter. +:ref:`Table 3 ` describes the response parameter. -.. _dcs-api-0312020__table1861319576383: +.. _dcs-api-0312020__en-us_topic_0166889614_table1861319576383: .. table:: **Table 3** Parameter description @@ -93,9 +93,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312020__table486141410130: +.. _dcs-api-0312020__en-us_topic_0166889614_table486141410130: .. table:: **Table 4** Status code diff --git a/api-ref/source/backup_and_restoration_apis/deleting_backup_files.rst b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/deleting_backup_files.rst similarity index 71% rename from api-ref/source/backup_and_restoration_apis/deleting_backup_files.rst rename to api-ref/source/outdated_apis_v1/backup_and_restoration_apis/deleting_backup_files.rst index f324168..195f46a 100644 --- a/api-ref/source/backup_and_restoration_apis/deleting_backup_files.rst +++ b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/deleting_backup_files.rst @@ -15,9 +15,9 @@ URI DELETE /v1.0/{project_id}/instances/{instance_id}/backups/{backup_id} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312024__table4154121820350: +.. _dcs-api-0312024__en-us_topic_0166889627_table4154121820350: .. table:: **Table 1** Parameter description @@ -38,6 +38,8 @@ None **Example request** +Request URL: + .. code-block:: text DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups/{backup_id} @@ -47,9 +49,9 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312024__table5929344419: +.. _dcs-api-0312024__en-us_topic_0166889627_table5929344419: .. table:: **Table 2** Parameter description @@ -70,9 +72,9 @@ Response Status Code ----------- -:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312024__table8301101911215: +.. _dcs-api-0312024__en-us_topic_0166889627_table8301101911215: .. table:: **Table 3** Status code diff --git a/api-ref/source/backup_and_restoration_apis/index.rst b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/index.rst similarity index 100% rename from api-ref/source/backup_and_restoration_apis/index.rst rename to api-ref/source/outdated_apis_v1/backup_and_restoration_apis/index.rst diff --git a/api-ref/source/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst similarity index 87% rename from api-ref/source/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst rename to api-ref/source/outdated_apis_v1/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst index 4ef85be..0c8fefb 100644 --- a/api-ref/source/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst +++ b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/querying_dcs_instance_backup_records.rst @@ -15,9 +15,9 @@ URI GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312022__table1899262913382: +.. _dcs-api-0312022__en-us_topic_0166889605_table1899262913382: .. table:: **Table 1** Parameter description @@ -55,69 +55,69 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312022__table1861319576383: +.. _dcs-api-0312022__en-us_topic_0166889605_table1861319576383: .. table:: **Table 2** Parameter description - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=========+================================================================================================================================+ - | backup_record_response | Array | Array of the backup records. For details about backup_record_response, see :ref:`Table 3 `. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------+ - | total_num | Integer | Number of obtained backup records. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=========+=======================================================================================================================================================+ + | backup_record_response | Array | Array of the backup records. For details about backup_record_response, see :ref:`Table 3 `. | + +------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | total_num | Integer | Number of obtained backup records. | + +------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312022__table82951233189: +.. _dcs-api-0312022__en-us_topic_0166889605_table82951233189: .. table:: **Table 3** backup_record_response parameter description - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================================+ - | status | String | Backup status. Options: | - | | | | - | | | - **waiting**: DCS instance restoration is waiting to begin. | - | | | - **backuping**: DCS instance backup is in progress. | - | | | - **succeed**: DCS instance backup succeeded. | - | | | - **failed**: DCS instance backup failed. | - | | | - **expired**: The backup file expires. | - | | | - **deleted**: The backup file has been deleted manually. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | remark | String | Description of DCS instance backup | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | period | String | Time segment in which DCS instance backup was performed | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | String | Backup progress | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Long | Size of the backup file. Unit: byte. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_id | String | DCS instance ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_id | String | ID of the backup record | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time at which the backup task is created | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time at which DCS instance backup is completed | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | execution_at | String | Time at which the backup starts. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_type | String | Backup type. Options: | - | | | | - | | | - **manual**: manual backup | - | | | - **auto**: automatic backup | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | is_support_restore | String | An indicator of whether restoration is supported. Options: **TRUE** or **FALSE**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===================================================================================================================================================================+ + | status | String | Backup status. Options: | + | | | | + | | | - **waiting**: DCS instance restoration is waiting to begin. | + | | | - **backuping**: DCS instance backup is in progress. | + | | | - **succeed**: DCS instance backup succeeded. | + | | | - **failed**: DCS instance backup failed. | + | | | - **expired**: The backup file expires. | + | | | - **deleted**: The backup file has been deleted manually. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remark | String | Description of DCS instance backup | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | period | String | Time segment in which DCS instance backup was performed | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | progress | String | Backup progress | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Long | Size of the backup file. Unit: byte. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | instance_id | String | DCS instance ID | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_id | String | ID of the backup record | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time at which the backup task is created | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time at which DCS instance backup is completed | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | execution_at | String | Time at which the backup starts. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_type | String | Backup type. Options: | + | | | | + | | | - **manual**: manual backup | + | | | - **auto**: automatic backup | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 `. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | is_support_restore | String | An indicator of whether restoration is supported. Options: **TRUE** or **FALSE**. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312022__table1255361919491: +.. _dcs-api-0312022__en-us_topic_0166889605_table1255361919491: .. table:: **Table 4** Error codes returned in case of a backup or restoration failure @@ -171,9 +171,9 @@ Response Status Code ----------- -:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312022__table486141410130: +.. _dcs-api-0312022__en-us_topic_0166889605_table486141410130: .. table:: **Table 5** Status code diff --git a/api-ref/source/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst similarity index 87% rename from api-ref/source/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst rename to api-ref/source/outdated_apis_v1/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst index 47ac0d0..ddfaa25 100644 --- a/api-ref/source/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst +++ b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/querying_dcs_instance_restoration_records.rst @@ -15,9 +15,9 @@ URI GET /v1.0/{project_id}/instances/{instance_id}/restores?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312023__table1899262913382: +.. _dcs-api-0312023__en-us_topic_0166889654_table1899262913382: .. table:: **Table 1** Parameter description @@ -55,9 +55,9 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312023__table1861319576383: +.. _dcs-api-0312023__en-us_topic_0166889654_table1861319576383: .. table:: **Table 2** Parameter description @@ -70,40 +70,40 @@ Response .. table:: **Table 3** restore_record_response parameter description - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================================+ - | status | String | Restoration status | - | | | | - | | | - **waiting**: DCS instance restoration is waiting to begin. | - | | | - **restoring**: DCS instance restoration is in progress. | - | | | - **succeed**: DCS instance restoration succeeded. | - | | | - **failed**: DCS instance restoration failed. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | String | Restoration progress | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | restore_id | String | ID of the restoration record | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_id | String | ID of the backup record | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | restore_remark | String | Description of DCS instance restoration | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | backup_remark | String | Description of DCS instance backup | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time at which the restoration task is created | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time at which DCS instance restoration completed | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | restore_name | String | Name of the restoration 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 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================================================================+ + | status | String | Restoration status | + | | | | + | | | - **waiting**: DCS instance restoration is waiting to begin. | + | | | - **restoring**: DCS instance restoration is in progress. | + | | | - **succeed**: DCS instance restoration succeeded. | + | | | - **failed**: DCS instance restoration failed. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | progress | String | Restoration progress | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | restore_id | String | ID of the restoration record | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_id | String | ID of the backup record | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | restore_remark | String | Description of DCS instance restoration | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | backup_remark | String | Description of DCS instance backup | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time at which the restoration task is created | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time at which DCS instance restoration completed | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | restore_name | String | Name of the restoration 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 `. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Example response** @@ -133,9 +133,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312023__table486141410130: +.. _dcs-api-0312023__en-us_topic_0166889654_table486141410130: .. table:: **Table 4** Status code diff --git a/api-ref/source/backup_and_restoration_apis/restoring_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/restoring_a_dcs_instance.rst similarity index 72% rename from api-ref/source/backup_and_restoration_apis/restoring_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/backup_and_restoration_apis/restoring_a_dcs_instance.rst index a784cb6..d69b455 100644 --- a/api-ref/source/backup_and_restoration_apis/restoring_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/backup_and_restoration_apis/restoring_a_dcs_instance.rst @@ -19,9 +19,9 @@ URI POST /v1.0/{project_id}/instances/{instance_id}/restores -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312021__table1899262913382: +.. _dcs-api-0312021__en-us_topic_0166889595_table1899262913382: .. table:: **Table 1** Parameter description @@ -37,9 +37,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312021__table153111335113816: +.. _dcs-api-0312021__en-us_topic_0166889595_table153111335113816: .. table:: **Table 2** Parameter description @@ -52,10 +52,14 @@ Request **Example request** +Request URL: + .. code-block:: text POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores +Example: + .. code-block:: { @@ -68,9 +72,9 @@ Response **Response parameters** -:ref:`Table 3 ` describes the response parameter. +:ref:`Table 3 ` describes the response parameter. -.. _dcs-api-0312021__table1861319576383: +.. _dcs-api-0312021__en-us_topic_0166889595_table1861319576383: .. table:: **Table 3** Parameter description @@ -91,9 +95,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312021__table486141410130: +.. _dcs-api-0312021__en-us_topic_0166889595_table486141410130: .. table:: **Table 4** Status code diff --git a/api-ref/source/data_migration_apis/creating_a_data_migration_task.rst b/api-ref/source/outdated_apis_v1/data_migration_apis/creating_a_data_migration_task.rst similarity index 66% rename from api-ref/source/data_migration_apis/creating_a_data_migration_task.rst rename to api-ref/source/outdated_apis_v1/data_migration_apis/creating_a_data_migration_task.rst index eb61750..d27cbc0 100644 --- a/api-ref/source/data_migration_apis/creating_a_data_migration_task.rst +++ b/api-ref/source/outdated_apis_v1/data_migration_apis/creating_a_data_migration_task.rst @@ -35,56 +35,56 @@ Request .. table:: **Table 2** Request body parameter description - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+========================================================================+==================================================================================================================================+ - | task_name | Yes | String | Name of the migration task. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description of the migration task. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | migration_type | Yes | String | Mode of the migration. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **backupfile_import**: indicates importing backup files. | - | | | | - **online_migration**: indicates migrating data online. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | migration_method | Yes | String | Type of the migration. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **full_amount_migration**: indicates a full migration. | - | | | | - **incremental_migration**: indicates an incremental migration. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | backup_files | No | :ref:`BackupFilesBody ` Object | Backup files to be imported when the migration mode is importing backup files. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | network_type | No | String | Type of the network for communication between the source and destination Redis when the migration mode is online data migration. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **vpc** | - | | | | - **vpn** | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | source_instance | No | :ref:`SourceInstanceBody ` Object | Source Redis information. This parameter is mandatory when the migration mode is online data migration. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | target_instance | Yes | :ref:`TargetInstanceBody ` Object | Destination Redis instance information. | - +------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+=================+===============================================================================================+==================================================================================================================================+ + | task_name | Yes | String | Name of the migration task. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description of the migration task. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | migration_type | Yes | String | Mode of the migration. | + | | | | | + | | | | Options: | + | | | | | + | | | | - **backupfile_import**: indicates importing backup files. | + | | | | - **online_migration**: indicates migrating data online. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | migration_method | Yes | String | Type of the migration. | + | | | | | + | | | | Options: | + | | | | | + | | | | - **full_amount_migration**: indicates a full migration. | + | | | | - **incremental_migration**: indicates an incremental migration. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | backup_files | No | :ref:`BackupFilesBody ` Object | Backup files to be imported when the migration mode is importing backup files. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | network_type | No | String | Type of the network for communication between the source and destination Redis when the migration mode is online data migration. | + | | | | | + | | | | Options: | + | | | | | + | | | | - **vpc** | + | | | | - **vpn** | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | source_instance | No | :ref:`SourceInstanceBody ` Object | Source Redis information. This parameter is mandatory when the migration mode is online data migration. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ + | target_instance | Yes | :ref:`TargetInstanceBody ` Object | Destination Redis instance information. | + +------------------+-----------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0514004__table52620454720: +.. _dcs-api-0514004__en-us_topic_0244978010_table52620454720: .. table:: **Table 3** BackupFilesBody - +-------------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+==================================================================+==========================================================================================+ - | file_source | No | String | Data source. Currently, only OBS buckets are supported. The value is **self_build_obs**. | - +-------------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | bucket_name | Yes | String | OBS bucket name. | - +-------------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------+ - | files | Yes | Array of :ref:`Files ` Objects | List of backup files to be imported. | - +-------------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + +-------------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+=========================================================================================+==========================================================================================+ + | file_source | No | String | Data source. Currently, only OBS buckets are supported. The value is **self_build_obs**. | + +-------------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | bucket_name | Yes | String | OBS bucket name. | + +-------------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ + | files | Yes | Array of :ref:`Files ` Objects | List of backup files to be imported. | + +-------------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ -.. _dcs-api-0514004__table4440451079: +.. _dcs-api-0514004__en-us_topic_0244978010_table4440451079: .. table:: **Table 4** Files @@ -98,7 +98,7 @@ Request | update_at | No | String | Time when the file is last modified. The format is YYYY-MM-DD HH:MM:SS. | +-----------+-----------+--------+-------------------------------------------------------------------------+ -.. _dcs-api-0514004__table1463144520714: +.. _dcs-api-0514004__en-us_topic_0244978010_table1463144520714: .. table:: **Table 5** SourceInstanceBody @@ -110,7 +110,7 @@ Request | password | No | String | Redis password. If a password is set, this parameter is mandatory. | +-----------+-----------+--------+---------------------------------------------------------------------+ -.. _dcs-api-0514004__table147217451875: +.. _dcs-api-0514004__en-us_topic_0244978010_table147217451875: .. table:: **Table 6** TargetInstanceBody @@ -234,4 +234,4 @@ Status Code Description Error Codes ----------- -For details, see :ref:`Error Codes `. +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/data_migration_apis/index.rst b/api-ref/source/outdated_apis_v1/data_migration_apis/index.rst similarity index 100% rename from api-ref/source/data_migration_apis/index.rst rename to api-ref/source/outdated_apis_v1/data_migration_apis/index.rst diff --git a/api-ref/source/outdated_apis_v1/index.rst b/api-ref/source/outdated_apis_v1/index.rst new file mode 100644 index 0000000..4ad912e --- /dev/null +++ b/api-ref/source/outdated_apis_v1/index.rst @@ -0,0 +1,24 @@ +:original_name: dcs-api-0605002.html + +.. _dcs-api-0605002: + +Outdated APIs (V1) +================== + +- :ref:`Lifecycle Management APIs ` +- :ref:`Instance Management APIs ` +- :ref:`Parameter Management APIs ` +- :ref:`Data Migration APIs ` +- :ref:`Backup and Restoration APIs ` +- :ref:`Other APIs ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + lifecycle_management_apis/index + instance_management_apis/index + parameter_management_apis/index + data_migration_apis/index + backup_and_restoration_apis/index + other_apis/index diff --git a/api-ref/source/instance_management_apis/changing_the_password_of_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/instance_management_apis/changing_the_password_of_a_dcs_instance.rst similarity index 90% rename from api-ref/source/instance_management_apis/changing_the_password_of_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/instance_management_apis/changing_the_password_of_a_dcs_instance.rst index 5d60c26..06e2535 100644 --- a/api-ref/source/instance_management_apis/changing_the_password_of_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/instance_management_apis/changing_the_password_of_a_dcs_instance.rst @@ -15,9 +15,9 @@ URI PUT /v1.0/{project_id}/instances/{instance_id}/password -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312019__table1899262913382: +.. _dcs-api-0312019__en-us_topic_0166889642_table1899262913382: .. table:: **Table 1** Parameter description @@ -33,9 +33,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312019__table153111335113816: +.. _dcs-api-0312019__en-us_topic_0166889642_table153111335113816: .. table:: **Table 2** Parameter description @@ -81,9 +81,9 @@ Response **Response parameters** -:ref:`Table 3 ` describes the response parameters. +:ref:`Table 3 ` describes the response parameters. -.. _dcs-api-0312019__table1861319576383: +.. _dcs-api-0312019__en-us_topic_0166889642_table1861319576383: .. table:: **Table 3** Parameter description @@ -130,9 +130,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312019__table486141410130: +.. _dcs-api-0312019__en-us_topic_0166889642_table486141410130: .. table:: **Table 4** Status code diff --git a/api-ref/source/instance_management_apis/index.rst b/api-ref/source/outdated_apis_v1/instance_management_apis/index.rst similarity index 100% rename from api-ref/source/instance_management_apis/index.rst rename to api-ref/source/outdated_apis_v1/instance_management_apis/index.rst diff --git a/api-ref/source/outdated_apis_v1/instance_management_apis/querying_dcs_instance_status.rst b/api-ref/source/outdated_apis_v1/instance_management_apis/querying_dcs_instance_status.rst new file mode 100644 index 0000000..2fb7706 --- /dev/null +++ b/api-ref/source/outdated_apis_v1/instance_management_apis/querying_dcs_instance_status.rst @@ -0,0 +1,219 @@ +: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?include_failure={include_failure} + +:ref:`Table 1 ` describes the parameters. + +.. _dcs-api-0312016__en-us_topic_0166889648_table1624017336377: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +=================+=================+=================+============================================================================================================================+ + | project_id | String | Yes | Project ID. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ + | 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: | + | | | | | + | | | | - **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?include_failure=true + +Response +-------- + +**Response parameters** + +:ref:`Table 2 ` describes the response parameters. + +.. _dcs-api-0312016__en-us_topic_0166889648_table595111370375: + +.. table:: **Table 2** Parameter description + + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +====================+==================================================================================================+================================================================+ + | redis | :ref:`StatusStatistic ` object | Redis instance quantity statistics. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | 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. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | upgrading_count | Integer | Number of instances that are being upgraded. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | paying_count | Integer | Number of instances for which payment is in progress. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | migrating_count | Integer | Number of instances on which data migration is in progress. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | flushing_count | Integer | Number of instances whose data is being cleared. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | closed_count | Integer | Number of instances that have been stopped. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | starting_count | Integer | Number of instances that are being started. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | closing_count | Integer | Number of instances that are being stopped. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + | restoring_count | Integer | Number of instances for which data restoration is in progress. | + +--------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------+ + +.. _dcs-api-0312016__en-us_topic_0166889648_response_statusstatistic: + +.. table:: **Table 3** StatusStatistic + + +--------------------+---------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +====================+=========+================================================================+ + | paying_count | Integer | Number of instances for which payment is in progress. | + +--------------------+---------+----------------------------------------------------------------+ + | migrating_count | Integer | Number of instances on which data migration is in progress. | + +--------------------+---------+----------------------------------------------------------------+ + | flushing_count | Integer | Number of instances whose data is being cleared. | + +--------------------+---------+----------------------------------------------------------------+ + | upgrading_count | Integer | Number of instances that are being upgraded. | + +--------------------+---------+----------------------------------------------------------------+ + | restoring_count | Integer | Number of instances for which data restoration is in progress. | + +--------------------+---------+----------------------------------------------------------------+ + | extending_count | Integer | Number of instances that are being scaled up. | + +--------------------+---------+----------------------------------------------------------------+ + | creating_count | Integer | Number of instances that are being created. | + +--------------------+---------+----------------------------------------------------------------+ + | running_count | Integer | Number of running instances. | + +--------------------+---------+----------------------------------------------------------------+ + | error_count | Integer | Number of abnormal instances. | + +--------------------+---------+----------------------------------------------------------------+ + | createfailed_count | Integer | Number of instances that fail to be created. | + +--------------------+---------+----------------------------------------------------------------+ + | restarting_count | Integer | Number of instances that are being restarted. | + +--------------------+---------+----------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum length: 1024 characters | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum length: 9 characters | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum length: 1024 characters | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Status code: 500** + +.. table:: **Table 5** Response body parameters + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================+ + | error_msg | String | Error message. | + | | | | + | | | Maximum length: 1024 characters | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_code | String | Error code. | + | | | | + | | | Maximum length: 9 characters | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + | error_ext_msg | String | Extended error information. This parameter is not used currently and is set to null. | + | | | | + | | | Maximum length: 1024 characters | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------+ + +**Example response** + +.. code-block:: + + { + "paying_count":0, + "migrating_count":0, + "error_count":0, + "restarting_count":0, + "createfailed_count":0, + "flushing_count":0, + "redis":{ + "paying_count":0, + "migrating_count":0, + "error_count":0, + "restarting_count":0, + "createfailed_count":0, + "flushing_count":0, + "closed_count":0, + "extending_count":2, + "creating_count":0, + "starting_count":0, + "closing_count":0, + "running_count":1, + "upgrading_count":0, + "restoring_count":0 + }, + "closed_count":0, + "extending_count":2, + "creating_count":0, + "starting_count":0, + "closing_count":0, + "running_count":1, + "upgrading_count":0, + "restoring_count":0} + } + +Status Code +----------- + +:ref:`Table 6 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. + +.. _dcs-api-0312016__en-us_topic_0166889648_table36591653133: + +.. table:: **Table 6** Status code + + +-------------+-------------------------------------------------------------------------+ + | Status Code | Description | + +=============+=========================================================================+ + | 200 | Quantities of DCS instances in different statuses queried successfully. | + +-------------+-------------------------------------------------------------------------+ + | 400 | The request is invalid. | + +-------------+-------------------------------------------------------------------------+ + | 500 | Internal service error. | + +-------------+-------------------------------------------------------------------------+ diff --git a/api-ref/source/instance_management_apis/querying_statistics_of_all_running_instances.rst b/api-ref/source/outdated_apis_v1/instance_management_apis/querying_statistics_of_all_running_instances.rst similarity index 82% rename from api-ref/source/instance_management_apis/querying_statistics_of_all_running_instances.rst rename to api-ref/source/outdated_apis_v1/instance_management_apis/querying_statistics_of_all_running_instances.rst index cf950fc..9fb0730 100644 --- a/api-ref/source/instance_management_apis/querying_statistics_of_all_running_instances.rst +++ b/api-ref/source/outdated_apis_v1/instance_management_apis/querying_statistics_of_all_running_instances.rst @@ -15,9 +15,9 @@ URI GET /v1.0/{project_id}/instances/statistic -:ref:`Table 1 ` describes the parameter. +:ref:`Table 1 ` describes the parameter. -.. _dcs-api-0312014__table8593726183514: +.. _dcs-api-0312014__en-us_topic_0166889591_table8593726183514: .. table:: **Table 1** Parameter description @@ -45,19 +45,19 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameter. +:ref:`Table 2 ` describes the response parameter. -.. _dcs-api-0312014__table254823012351: +.. _dcs-api-0312014__en-us_topic_0166889591_table254823012351: .. table:: **Table 2** Parameter description - +------------+-------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+=======+===========================================================================================================================+ - | statistics | Array | Statistics of all instances in the **Running** state. For details, see :ref:`Table 3 `. | - +------------+-------+---------------------------------------------------------------------------------------------------------------------------+ + +------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+=======+==================================================================================================================================================+ + | statistics | Array | Statistics of all instances in the **Running** state. For details, see :ref:`Table 3 `. | + +------------+-------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312014__table7914256164: +.. _dcs-api-0312014__en-us_topic_0166889591_table7914256164: .. table:: **Table 3** statistics parameter description @@ -127,9 +127,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312014__table63992308123: +.. _dcs-api-0312014__en-us_topic_0166889591_table63992308123: .. table:: **Table 4** Status code diff --git a/api-ref/source/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst b/api-ref/source/outdated_apis_v1/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst similarity index 84% rename from api-ref/source/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst rename to api-ref/source/outdated_apis_v1/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst index 49ea12b..50f8322 100644 --- a/api-ref/source/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst +++ b/api-ref/source/outdated_apis_v1/instance_management_apis/restarting_dcs_instances_or_clearing_dcs_instance_data.rst @@ -17,9 +17,9 @@ URI PUT /v1.0/{project_id}/instances/status -:ref:`Table 1 ` describes the parameter. +:ref:`Table 1 ` describes the parameter. -.. _dcs-api-0312018__table344154216371: +.. _dcs-api-0312018__en-us_topic_0166889632_table344154216371: .. table:: **Table 1** Parameter description @@ -34,9 +34,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312018__table103786452372: +.. _dcs-api-0312018__en-us_topic_0166889632_table103786452372: .. table:: **Table 2** Parameter description @@ -76,9 +76,9 @@ Response **Response parameters** -:ref:`Table 3 ` describes the response parameter. +:ref:`Table 3 ` describes the response parameter. -.. _dcs-api-0312018__table52851943388: +.. _dcs-api-0312018__en-us_topic_0166889632_table52851943388: .. table:: **Table 3** Parameter description @@ -114,9 +114,9 @@ Response Status Code ----------- -:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312018__table1357115714126: +.. _dcs-api-0312018__en-us_topic_0166889632_table1357115714126: .. table:: **Table 5** Status code diff --git a/api-ref/source/lifecycle_management_apis/batch_deleting_dcs_instances.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/batch_deleting_dcs_instances.rst similarity index 87% rename from api-ref/source/lifecycle_management_apis/batch_deleting_dcs_instances.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/batch_deleting_dcs_instances.rst index 1deb4ec..b1c86b3 100644 --- a/api-ref/source/lifecycle_management_apis/batch_deleting_dcs_instances.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/batch_deleting_dcs_instances.rst @@ -15,9 +15,9 @@ URI DELETE /v1.0/{project_id}/instances?allFailure={allFailure} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312009__table4154121820350: +.. _dcs-api-0312009__en-us_topic_0166889613_table4154121820350: .. table:: **Table 1** Parameter description @@ -39,9 +39,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312009__table166993107405: +.. _dcs-api-0312009__en-us_topic_0166889613_table166993107405: .. table:: **Table 2** Parameter description @@ -77,19 +77,19 @@ Response **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 ` is 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 ` is returned. -.. _dcs-api-0312009__table18935105020414: +.. _dcs-api-0312009__en-us_topic_0166889613_table18935105020414: .. table:: **Table 3** Parameter description - +-----------+-------+---------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=======+=========================================================================================================+ - | results | Array | For details about how to delete an instance, see :ref:`Table 4 `. | - +-----------+-------+---------------------------------------------------------------------------------------------------------+ + +-----------+-------+--------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=======+================================================================================================================================+ + | results | Array | For details about how to delete an instance, see :ref:`Table 4 `. | + +-----------+-------+--------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312009__table69371750154117: +.. _dcs-api-0312009__en-us_topic_0166889613_table69371750154117: .. table:: **Table 4** results parameter description @@ -121,9 +121,9 @@ If the value of the **allFailure** parameter in the URI is **false**, an empty r Status Code ----------- -:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312009__table8301101911215: +.. _dcs-api-0312009__en-us_topic_0166889613_table8301101911215: .. table:: **Table 5** Status codes diff --git a/api-ref/source/lifecycle_management_apis/creating_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/creating_a_dcs_instance.rst similarity index 96% rename from api-ref/source/lifecycle_management_apis/creating_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/creating_a_dcs_instance.rst index 96ed8ab..96dd84f 100644 --- a/api-ref/source/lifecycle_management_apis/creating_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/creating_a_dcs_instance.rst @@ -19,9 +19,9 @@ URI POST /v1.0/{project_id}/instances -:ref:`Table 1 ` describes the parameter. +:ref:`Table 1 ` describes the parameter. -.. _dcs-api-0312004__table9695164612327: +.. _dcs-api-0312004__en-us_topic_0166889598_table9695164612327: .. table:: **Table 1** Parameter description @@ -36,9 +36,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312004__table56761820495: +.. _dcs-api-0312004__en-us_topic_0166889598_table56761820495: .. table:: **Table 2** Parameter description @@ -135,7 +135,7 @@ Request +-------------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | instance_backup_policy | Object | No | Backup policy. | | | | | | - | | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 ` and :ref:`Table 4 `. | + | | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 ` and :ref:`Table 4 `. | +-------------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enable_publicip | Boolean | No | An indicator of whether to enable public access for a DCS Redis instance. | | | | | | @@ -189,34 +189,34 @@ Request | | | | If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, no critical command will be renamed. Currently, only **COMMAND**, **KEYS**, **FLUSHDB**, **FLUSHALL**, and **HGETALL** commands can be renamed. | +-------------------------+------------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312004__table12803218151513: +.. _dcs-api-0312004__en-us_topic_0166889598_table12803218151513: .. table:: **Table 3** instance_backup_policy parameter description - +------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +========================+=================+=================+=======================================================================================+ - | save_days | Integer | No | This parameter is mandatory when **backup_type** is set to **manual**. | - | | | | | - | | | | Retention period. | - | | | | | - | | | | Unit: day. | - | | | | | - | | | | Value range: 1-7. | - +------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------+ - | backup_type | String | No | Backup type. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **auto**: automatic backup. | - | | | | - **manual**: manual backup. | - | | | | | - | | | | The default value is **manual**. | - +------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------+ - | periodical_backup_plan | Object | Yes | Backup plan. For details, see :ref:`Table 4 `. | - +------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------+ + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +========================+=================+=================+==============================================================================================================+ + | save_days | Integer | No | This parameter is mandatory when **backup_type** is set to **manual**. | + | | | | | + | | | | Retention period. | + | | | | | + | | | | Unit: day. | + | | | | | + | | | | Value range: 1-7. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ + | backup_type | String | No | Backup type. | + | | | | | + | | | | Options: | + | | | | | + | | | | - **auto**: automatic backup. | + | | | | - **manual**: manual backup. | + | | | | | + | | | | The default value is **manual**. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ + | periodical_backup_plan | Object | Yes | Backup plan. For details, see :ref:`Table 4 `. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312004__table187492037201518: +.. _dcs-api-0312004__en-us_topic_0166889598_table187492037201518: .. table:: **Table 4** periodical_backup_plan parameter description @@ -285,21 +285,21 @@ Response **Response parameters** -:ref:`Table 5 ` describes the response parameters. +:ref:`Table 5 ` describes the response parameters. -.. _dcs-api-0312004__table079510368334: +.. _dcs-api-0312004__en-us_topic_0166889598_table079510368334: .. table:: **Table 5** Parameter description - +-------------+------------------+------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+==================+==========================================================================================+ - | instance_id | String | DCS instance ID. | - +-------------+------------------+------------------------------------------------------------------------------------------+ - | instances | Array of Objects | DCS instance list. For details, see :ref:`Table 6 `. | - +-------------+------------------+------------------------------------------------------------------------------------------+ + +-------------+------------------+-----------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+==================+=================================================================================================================+ + | instance_id | String | DCS instance ID. | + +-------------+------------------+-----------------------------------------------------------------------------------------------------------------+ + | instances | Array of Objects | DCS instance list. For details, see :ref:`Table 6 `. | + +-------------+------------------+-----------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312004__table128250386224: +.. _dcs-api-0312004__en-us_topic_0166889598_table128250386224: .. table:: **Table 6** instances parameters @@ -327,9 +327,9 @@ Response Status Code ----------- -:ref:`Table 7 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 7 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312004__table217814394526: +.. _dcs-api-0312004__en-us_topic_0166889598_table217814394526: .. table:: **Table 7** Status code diff --git a/api-ref/source/lifecycle_management_apis/deleting_a_single_dcs_instance.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/deleting_a_single_dcs_instance.rst similarity index 72% rename from api-ref/source/lifecycle_management_apis/deleting_a_single_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/deleting_a_single_dcs_instance.rst index a8934f0..bc709ba 100644 --- a/api-ref/source/lifecycle_management_apis/deleting_a_single_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/deleting_a_single_dcs_instance.rst @@ -15,9 +15,9 @@ URI DELETE /v1.0/{project_id}/instances/{instance_id} -:ref:`Table 1 ` describes the parameter. +:ref:`Table 1 ` describes the parameter. -.. _dcs-api-0312008__table4154121820350: +.. _dcs-api-0312008__en-us_topic_0166889633_table4154121820350: .. table:: **Table 1** Parameter description @@ -57,9 +57,9 @@ None Status Code ----------- -:ref:`Table 2 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 2 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312008__table8301101911215: +.. _dcs-api-0312008__en-us_topic_0166889633_table8301101911215: .. table:: **Table 2** Status code diff --git a/api-ref/source/lifecycle_management_apis/index.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/index.rst similarity index 100% rename from api-ref/source/lifecycle_management_apis/index.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/index.rst diff --git a/api-ref/source/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst similarity index 95% rename from api-ref/source/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst index e5cf998..9ebe8c8 100644 --- a/api-ref/source/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/modifying_information_about_a_dcs_instance.rst @@ -15,9 +15,9 @@ URI PUT /v1.0/{project_id}/instances/{instance_id} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312007__table938420556341: +.. _dcs-api-0312007__en-us_topic_0166889612_table938420556341: .. table:: **Table 1** Parameter description @@ -33,9 +33,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312007__table785213273513: +.. _dcs-api-0312007__en-us_topic_0166889612_table785213273513: .. table:: **Table 2** Parameter description @@ -56,7 +56,7 @@ Request +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | instance_backup_policy | Object | No | Backup policy. | | | | | | - | | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 ` and :ref:`Table 4 `. | + | | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 ` and :ref:`Table 4 `. | +------------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | maintain_begin | String | No | Time at which the maintenance time window starts. | | | | | | @@ -140,9 +140,9 @@ None Status Code ----------- -:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312007__table1475915181216: +.. _dcs-api-0312007__en-us_topic_0166889612_table1475915181216: .. table:: **Table 3** Status code diff --git a/api-ref/source/lifecycle_management_apis/querying_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/querying_a_dcs_instance.rst similarity index 96% rename from api-ref/source/lifecycle_management_apis/querying_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/querying_a_dcs_instance.rst index dd08fb5..42362e0 100644 --- a/api-ref/source/lifecycle_management_apis/querying_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/querying_a_dcs_instance.rst @@ -15,9 +15,9 @@ URI GET /v1.0/{project_id}/instances/{instance_id} -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312005__table374812348341: +.. _dcs-api-0312005__en-us_topic_0166889618_table374812348341: .. table:: **Table 1** Parameter description @@ -49,9 +49,9 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312005__table1257921310816: +.. _dcs-api-0312005__en-us_topic_0166889618_table1257921310816: .. table:: **Table 2** Parameter description @@ -113,7 +113,7 @@ Response +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | error_code | String | Error code returned when the DCS instance fails to be created or is abnormal. | | | | | - | | | For details about error codes, see :ref:`Error Codes `. | + | | | For details about error codes, see :ref:`Error Codes `. | +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | user_id | String | User ID. | +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -206,7 +206,7 @@ Response +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | instance_backup_policy | Object | Backup policy. | | | | | - | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 `. | + | | | This parameter is available for master/standby and cluster DCS instances. For details, see :ref:`Table 3 `. | +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of Objects | Instance tag key and value. | +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -251,23 +251,23 @@ Response | sharding_count | int | Number of shards. | +--------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312005__table16210754181112: +.. _dcs-api-0312005__en-us_topic_0166889618_table16210754181112: .. table:: **Table 3** instance_backup_policy - +------------------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+========+====================================================================================================================================+ - | backup_policy_id | String | Backup policy ID. | - +------------------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time. | - +------------------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time. | - +------------------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | policy | Object | For details, see :ref:`Table 3 ` and :ref:`Table 4 `. | - +------------------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Tenant ID. | - +------------------+--------+------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+========+==================================================================================================================================================================================+ + | backup_policy_id | String | Backup policy ID. | + +------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time. | + +------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time. | + +------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | policy | Object | For details, see :ref:`Table 3 ` and :ref:`Table 4 `. | + +------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Tenant ID. | + +------------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Example response** @@ -352,9 +352,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312005__table183731131183: +.. _dcs-api-0312005__en-us_topic_0166889618_table183731131183: .. table:: **Table 4** Status code diff --git a/api-ref/source/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst similarity index 86% rename from api-ref/source/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst index 6ad1e0d..140e817 100644 --- a/api-ref/source/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/querying_all_dcs_instances_of_a_tenant.rst @@ -13,58 +13,56 @@ This API is used to query DCS instances of a tenant, and allows you to specify q 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 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312006__table1971216413394: +.. _dcs-api-0312006__en-us_topic_0166889639_table1971216413394: .. table:: **Table 1** Parameter description - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +==================+==================+=================+======================================================================================================================+ - | project_id | String | Yes | Project ID. | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | start | Integer | No | Start number for querying DCS instances. It cannot be lower than 1. | - | | | | | - | | | | By default, the start number is 1. | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | No | Number of DCS instances displayed on each page. | - | | | | | - | | | | Minimum value: **1** | - | | | | | - | | | | Maximum value: **2000** | - | | | | | - | | | | If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page. | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | name | String | No | DCS instance name. | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | id | String | No | Instance ID. | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | status | String | No | DCS instance status. For details about status, see :ref:`DCS Instance Statuses `. | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | 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. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **true**: exact match | - | | | | - **false**: fuzzy match | - | | | | | - | | | | 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. | - | | | | | - | | | | To query instances with multiple tag keys and values, separate key-value pairs with commas (,). | - +------------------+------------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +=================+==================+=================+=======================================================================================================================+ + | project_id | String | Yes | Project ID. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | start | Integer | No | Start number for querying DCS instances. It cannot be lower than 1. | + | | | | | + | | | | By default, the start number is 1. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | No | Number of DCS instances displayed on each page. | + | | | | | + | | | | Minimum value: **1** | + | | | | | + | | | | Maximum value: **2000** | + | | | | | + | | | | If this parameter is left unspecified, a maximum of 1000 DCS instances are displayed on each page. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | name | String | No | DCS instance name. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | id | String | No | Instance ID. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | status | String | No | DCS instance status. For details about status, see :ref:`DCS Instance Statuses `. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | ip | String | No | IP address for connecting to the DCS instance | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | 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: | + | | | | | + | | | | - **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. | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ + | 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 (,). | + +-----------------+------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+ **Example** .. 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 ------- @@ -82,9 +80,9 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312006__table189371511113913: +.. _dcs-api-0312006__en-us_topic_0166889639_table189371511113913: .. table:: **Table 2** Parameter description @@ -95,7 +93,7 @@ Response instance_num Integer Number of DCS instances. ============ ======= ============================== -.. table:: **Table 3** Parameter description of the instance array +.. table:: **Table 3** instances parameters +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -148,7 +146,7 @@ Response +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | Time at which the DCS instance is created. For example, 2017-03-31\ **T**\ 12:24:46.297\ **Z**. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see :ref:`Error Codes `. | + | error_code | String | Error code returned when the DCS instance fails to be created or is abnormal. For details about error codes, see :ref:`Error Codes `. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | user_id | String | User ID. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -265,9 +263,9 @@ Response Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312006__table3445625171318: +.. _dcs-api-0312006__en-us_topic_0166889639_table3445625171318: .. table:: **Table 4** Status code diff --git a/api-ref/source/lifecycle_management_apis/scaling_up_a_dcs_instance.rst b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/scaling_up_a_dcs_instance.rst similarity index 86% rename from api-ref/source/lifecycle_management_apis/scaling_up_a_dcs_instance.rst rename to api-ref/source/outdated_apis_v1/lifecycle_management_apis/scaling_up_a_dcs_instance.rst index f7141ce..f9f1dc4 100644 --- a/api-ref/source/lifecycle_management_apis/scaling_up_a_dcs_instance.rst +++ b/api-ref/source/outdated_apis_v1/lifecycle_management_apis/scaling_up_a_dcs_instance.rst @@ -15,9 +15,9 @@ URI POST /v1.0/{project_id}/instances/{instance_id}/extend -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312010__table4154121820350: +.. _dcs-api-0312010__en-us_topic_0166889656_table4154121820350: .. table:: **Table 1** Parameter description @@ -33,9 +33,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312010__table166993107405: +.. _dcs-api-0312010__en-us_topic_0166889656_table166993107405: .. table:: **Table 2** Parameter description @@ -83,9 +83,9 @@ None Status Code ----------- -:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312010__table8301101911215: +.. _dcs-api-0312010__en-us_topic_0166889656_table8301101911215: .. table:: **Table 3** Status code diff --git a/api-ref/source/other_apis/index.rst b/api-ref/source/outdated_apis_v1/other_apis/index.rst similarity index 100% rename from api-ref/source/other_apis/index.rst rename to api-ref/source/outdated_apis_v1/other_apis/index.rst diff --git a/api-ref/source/other_apis/querying_az_information.rst b/api-ref/source/outdated_apis_v1/other_apis/querying_az_information.rst similarity index 81% rename from api-ref/source/other_apis/querying_az_information.rst rename to api-ref/source/outdated_apis_v1/other_apis/querying_az_information.rst index c844b4f..e25f0a5 100644 --- a/api-ref/source/other_apis/querying_az_information.rst +++ b/api-ref/source/outdated_apis_v1/other_apis/querying_az_information.rst @@ -31,21 +31,21 @@ Response **Response parameters** -:ref:`Table 1 ` describes the response parameters. +:ref:`Table 1 ` describes the response parameters. -.. _dcs-api-0312039__table5725353918: +.. _dcs-api-0312039__en-us_topic_0166889630_table5725353918: .. table:: **Table 1** Parameter description - +-----------------+--------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+=======================================================================================+ - | regionId | String | Region ID. | - +-----------------+--------+---------------------------------------------------------------------------------------+ - | available_zones | Array | Array of AZs. For details, see :ref:`Table 2 `. | - +-----------------+--------+---------------------------------------------------------------------------------------+ + +-----------------+--------+--------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+==============================================================================================================+ + | region_id | String | Region ID. | + +-----------------+--------+--------------------------------------------------------------------------------------------------------------+ + | available_zones | Array | Array of AZs. For details, see :ref:`Table 2 `. | + +-----------------+--------+--------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312039__table20901104905614: +.. _dcs-api-0312039__en-us_topic_0166889630_table20901104905614: .. table:: **Table 2** Parameter description of the available_zones array @@ -105,9 +105,9 @@ Response Status Code ----------- -:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312039__table201151124142: +.. _dcs-api-0312039__en-us_topic_0166889630_table201151124142: .. table:: **Table 3** Status code diff --git a/api-ref/source/other_apis/querying_maintenance_time_window.rst b/api-ref/source/outdated_apis_v1/other_apis/querying_maintenance_time_window.rst similarity index 88% rename from api-ref/source/other_apis/querying_maintenance_time_window.rst rename to api-ref/source/outdated_apis_v1/other_apis/querying_maintenance_time_window.rst index 0825936..e8e70f2 100644 --- a/api-ref/source/other_apis/querying_maintenance_time_window.rst +++ b/api-ref/source/outdated_apis_v1/other_apis/querying_maintenance_time_window.rst @@ -31,9 +31,9 @@ Response **Response parameters** -:ref:`Table 1 ` describes the response parameters. +:ref:`Table 1 ` describes the response parameters. -.. _dcs-api-0312041__table615617458391: +.. _dcs-api-0312041__en-us_topic_0166889588_table615617458391: .. table:: **Table 1** Parameter description @@ -105,9 +105,9 @@ Response Status Code ----------- -:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 3 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312041__table611872191420: +.. _dcs-api-0312041__en-us_topic_0166889588_table611872191420: .. table:: **Table 3** Status code diff --git a/api-ref/source/other_apis/querying_service_specifications.rst b/api-ref/source/outdated_apis_v1/other_apis/querying_service_specifications.rst similarity index 69% rename from api-ref/source/other_apis/querying_service_specifications.rst rename to api-ref/source/outdated_apis_v1/other_apis/querying_service_specifications.rst index 54db16f..13479de 100644 --- a/api-ref/source/other_apis/querying_service_specifications.rst +++ b/api-ref/source/outdated_apis_v1/other_apis/querying_service_specifications.rst @@ -31,9 +31,9 @@ Response **Response parameters** -:ref:`Table 1 ` describes the response parameters. +:ref:`Table 1 ` describes the response parameters. -.. _dcs-api-0312040__table18437193323916: +.. _dcs-api-0312040__en-us_topic_0166889650_table18437193323916: .. table:: **Table 1** Parameter description @@ -45,216 +45,216 @@ Response .. table:: **Table 2** products parameter description - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+============================================================================================================================+ - | product_id | String | Product ID used to differentiate DCS specifications. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | spec_code | String | DCS instance specification code. Options: | - | | | | - | | | - dcs.single_node | - | | | - dcs.master_standby | - | | | - dcs.cluster | - | | | - redis.ha.xu1.tiny.r4.512 | - | | | - redis.ha.xu1.tiny.r2.128 | - | | | - redis.cluster.xu1.large.r5.4 | - | | | - redis.ha.xu1.tiny.r4.256 | - | | | - redis.ha.xu1.tiny.r2.512 | - | | | - redis.cluster.xu1.large.r1.32 | - | | | - redis.cluster.xu1.large.r4.768 | - | | | - redis.ha.xu1.large.r3.2 | - | | | - redis.single.xu1.large.64 | - | | | - redis.cluster.xu1.large.r5.8 | - | | | - redis.ha.xu1.large.r3.32 | - | | | - redis.cluster.xu1.large.r2.8 | - | | | - redis.ha.xu1.large.r4.1 | - | | | - redis.ha.xu1.tiny.r2.256 | - | | | - redis.cluster.xu1.large.r4.1024 | - | | | - redis.ha.xu1.large.r5.16 | - | | | - redis.cluster.xu1.large.r4.32 | - | | | - redis.ha.xu1.large.r5.24 | - | | | - redis.ha.xu1.large.r4.64 | - | | | - redis.cluster.xu1.large.r2.1024 | - | | | - redis.ha.xu1.large.r2.48 | - | | | - redis.ha.xu1.large.r2.24 | - | | | - redis.ha.xu1.large.r5.64 | - | | | - redis.ha.xu1.tiny.r5.512 | - | | | - redis.ha.xu1.large.r3.8 | - | | | - redis.cluster.xu1.large.r1.768 | - | | | - redis.ha.xu1.large.r3.24 | - | | | - redis.cluster.xu1.large.r3.512 | - | | | - redis.ha.xu1.large.r3.1 | - | | | - redis.cluster.xu1.large.r4.4 | - | | | - redis.cluster.xu1.large.r1.24 | - | | | - redis.ha.xu1.large.r4.2 | - | | | - redis.cluster.xu1.large.r5.192 | - | | | - redis.single.xu1.large.16 | - | | | - redis.cluster.xu1.large.r3.1024 | - | | | - redis.ha.xu1.large.r4.24 | - | | | - redis.cluster.xu1.large.r2.48 | - | | | - redis.ha.xu1.large.r2.1 | - | | | - redis.ha.xu1.large.r3.48 | - | | | - redis.single.xu1.large.4 | - | | | - redis.cluster.xu1.large.r4.48 | - | | | - redis.cluster.xu1.large.r3.768 | - | | | - redis.ha.xu1.tiny.r4.128 | - | | | - redis.ha.xu1.large.r5.1 | - | | | - redis.cluster.xu1.large.r2.96 | - | | | - redis.cluster.xu1.large.r3.4 | - | | | - redis.cluster.xu1.large.r1.128 | - | | | - redis.single.xu1.large.2 | - | | | - redis.ha.xu1.tiny.r3.128 | - | | | - redis.cluster.xu1.large.r2.512 | - | | | - redis.cluster.xu1.large.r3.8 | - | | | - redis.cluster.xu1.large.r4.128 | - | | | - redis.cluster.xu1.large.r3.96 | - | | | - redis.ha.xu1.large.r4.8 | - | | | - redis.ha.xu1.large.r5.48 | - | | | - redis.single.xu1.large.8 | - | | | - redis.cluster.xu1.large.r2.24 | - | | | - redis.cluster.xu1.large.r1.4 | - | | | - redis.cluster.xu1.large.r5.32 | - | | | - redis.cluster.xu1.large.r1.64 | - | | | - redis.cluster.xu1.large.r4.96 | - | | | - redis.single.xu1.tiny.256 | - | | | - redis.cluster.xu1.large.r5.128 | - | | | - redis.cluster.xu1.large.r2.16 | - | | | - redis.cluster.xu1.large.r4.8 | - | | | - redis.cluster.xu1.large.r4.512 | - | | | - redis.cluster.xu1.large.r1.384 | - | | | - redis.cluster.xu1.large.r5.768 | - | | | - redis.cluster.xu1.large.r3.256 | - | | | - redis.cluster.xu1.large.r1.256 | - | | | - redis.cluster.xu1.large.r4.64 | - | | | - redis.cluster.xu1.large.r5.256 | - | | | - redis.cluster.xu1.large.r4.384 | - | | | - redis.ha.xu1.tiny.r5.128 | - | | | - redis.cluster.xu1.large.r3.24 | - | | | - redis.cluster.xu1.large.r4.192 | - | | | - redis.cluster.xu1.large.r1.96 | - | | | - redis.ha.xu1.large.r2.2 | - | | | - redis.single.xu1.large.24 | - | | | - redis.ha.xu1.large.r4.4 | - | | | - redis.cluster.xu1.large.r1.1024 | - | | | - redis.ha.xu1.large.r2.16 | - | | | - redis.ha.xu1.large.r4.16 | - | | | - redis.cluster.xu1.large.r5.96 | - | | | - redis.cluster.xu1.large.r5.384 | - | | | - redis.cluster.xu1.large.r3.16 | - | | | - redis.ha.xu1.large.r3.16 | - | | | - redis.ha.xu1.large.r4.32 | - | | | - redis.ha.xu1.tiny.r5.256 | - | | | - redis.single.xu1.large.32 | - | | | - redis.ha.xu1.large.r5.2 | - | | | - redis.cluster.xu1.large.r1.16 | - | | | - redis.cluster.xu1.large.r2.384 | - | | | - redis.cluster.xu1.large.r2.192 | - | | | - redis.cluster.xu1.large.r1.48 | - | | | - redis.ha.xu1.large.r5.8 | - | | | - redis.cluster.xu1.large.r5.16 | - | | | - redis.cluster.xu1.large.r3.128 | - | | | - redis.ha.xu1.large.r3.4 | - | | | - redis.cluster.xu1.large.r1.192 | - | | | - redis.cluster.xu1.large.r3.384 | - | | | - redis.cluster.xu1.large.r2.4 | - | | | - redis.ha.xu1.large.r2.4 | - | | | - redis.single.xu1.tiny.128 | - | | | - redis.cluster.xu1.large.r1.512 | - | | | - redis.ha.xu1.large.r2.64 | - | | | - redis.cluster.xu1.large.r2.128 | - | | | - redis.cluster.xu1.large.r2.768 | - | | | - redis.cluster.xu1.large.r5.64 | - | | | - redis.cluster.xu1.large.r3.48 | - | | | - redis.single.xu1.tiny.512 | - | | | - redis.cluster.xu1.large.r5.48 | - | | | - redis.ha.xu1.large.r4.48 | - | | | - redis.cluster.xu1.large.r4.24 | - | | | - redis.ha.xu1.large.r5.4 | - | | | - redis.ha.xu1.large.r2.8 | - | | | - redis.ha.xu1.large.r3.64 | - | | | - redis.cluster.xu1.large.r2.64 | - | | | - redis.cluster.xu1.large.r2.32 | - | | | - redis.cluster.xu1.large.r4.16 | - | | | - redis.cluster.xu1.large.r4.256 | - | | | - redis.single.xu1.large.1 | - | | | - redis.cluster.xu1.large.r1.8 | - | | | - redis.cluster.xu1.large.r3.32 | - | | | - redis.single.xu1.large.48 | - | | | - redis.cluster.xu1.large.r5.1024 | - | | | - redis.cluster.xu1.large.r3.192 | - | | | - redis.cluster.xu1.large.r2.256 | - | | | - redis.ha.xu1.tiny.r3.256 | - | | | - redis.cluster.xu1.large.r5.24 | - | | | - redis.ha.xu1.tiny.r3.512 | - | | | - redis.cluster.xu1.large.r5.512 | - | | | - redis.ha.xu1.large.r5.32 | - | | | - redis.cluster.xu1.large.r3.64 | - | | | - redis.ha.xu1.large.r2.32 | - | | | - redis.ha.xu1.large.p2.16 | - | | | - redis.ha.xu1.large.p2.32 | - | | | - redis.ha.xu1.large.p2.64 | - | | | - redis.ha.xu1.large.p2.8 | - | | | - redis.ha.xu1.large.p3.16 | - | | | - redis.ha.xu1.large.p3.32 | - | | | - redis.ha.xu1.large.p3.64 | - | | | - redis.ha.xu1.large.p3.8 | - | | | - redis.ha.xu1.large.p4.16 | - | | | - redis.ha.xu1.large.p4.32 | - | | | - redis.ha.xu1.large.p4.64 | - | | | - redis.ha.xu1.large.p4.8 | - | | | - redis.ha.xu1.large.p5.16 | - | | | - redis.ha.xu1.large.p5.32 | - | | | - redis.ha.xu1.large.p5.64 | - | | | - redis.ha.xu1.large.p5.8 | - | | | - redis.ha.xu1.large.p6.16 | - | | | - redis.ha.xu1.large.p6.32 | - | | | - redis.ha.xu1.large.p6.64 | - | | | - redis.ha.xu1.large.p6.8 | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | cache_mode | String | DCS instance type. Options: | - | | | | - | | | - **single**: single-node | - | | | - **ha**: master/standby | - | | | - **cluster**: Redis Cluster | - | | | - **proxy**: Proxy Cluster | - | | | - **ha_rw_split**: read/write splitting | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | product_type | String | Edition of DCS for Redis. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | cpu_type | String | CPU architecture. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | storage_type | String | Storage type. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | details | Array of Object | Details of the specifications. :ref:`Table 3 ` describes the parameters in this array. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | engine | String | Cache engine. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | engine_versions | String | Cache engine version. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | spec_details | String | DCS specifications. The value subjects to the returned specifications. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | spec_details2 | String | Detailed DCS specifications, including the maximum number of connections and maximum memory size. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | charging_type | String | Billing mode. Value: **Hourly**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | price | Double | Price of the DCS service to which you can subscribe. (This parameter has been abandoned.) | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | currency | String | Currency. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | prod_type | String | Product type. | - | | | | - | | | Options: **instance** and **obs_space**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | cloud_service_type_code | String | Cloud service type code. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | cloud_resource_type_code | String | Cloud resource type code. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | flavors | Array | AZs with available resources. :ref:`Table 4 ` describes the parameters in this array. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | billing_factor | String | Billing item. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=======================+===================================================================================================================================================+ + | product_id | String | Product ID used to differentiate DCS specifications. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_code | String | DCS instance specification code. Options: | + | | | | + | | | - dcs.single_node | + | | | - dcs.master_standby | + | | | - dcs.cluster | + | | | - redis.ha.xu1.tiny.r4.512 | + | | | - redis.ha.xu1.tiny.r2.128 | + | | | - redis.cluster.xu1.large.r5.4 | + | | | - redis.ha.xu1.tiny.r4.256 | + | | | - redis.ha.xu1.tiny.r2.512 | + | | | - redis.cluster.xu1.large.r1.32 | + | | | - redis.cluster.xu1.large.r4.768 | + | | | - redis.ha.xu1.large.r3.2 | + | | | - redis.single.xu1.large.64 | + | | | - redis.cluster.xu1.large.r5.8 | + | | | - redis.ha.xu1.large.r3.32 | + | | | - redis.cluster.xu1.large.r2.8 | + | | | - redis.ha.xu1.large.r4.1 | + | | | - redis.ha.xu1.tiny.r2.256 | + | | | - redis.cluster.xu1.large.r4.1024 | + | | | - redis.ha.xu1.large.r5.16 | + | | | - redis.cluster.xu1.large.r4.32 | + | | | - redis.ha.xu1.large.r5.24 | + | | | - redis.ha.xu1.large.r4.64 | + | | | - redis.cluster.xu1.large.r2.1024 | + | | | - redis.ha.xu1.large.r2.48 | + | | | - redis.ha.xu1.large.r2.24 | + | | | - redis.ha.xu1.large.r5.64 | + | | | - redis.ha.xu1.tiny.r5.512 | + | | | - redis.ha.xu1.large.r3.8 | + | | | - redis.cluster.xu1.large.r1.768 | + | | | - redis.ha.xu1.large.r3.24 | + | | | - redis.cluster.xu1.large.r3.512 | + | | | - redis.ha.xu1.large.r3.1 | + | | | - redis.cluster.xu1.large.r4.4 | + | | | - redis.cluster.xu1.large.r1.24 | + | | | - redis.ha.xu1.large.r4.2 | + | | | - redis.cluster.xu1.large.r5.192 | + | | | - redis.single.xu1.large.16 | + | | | - redis.cluster.xu1.large.r3.1024 | + | | | - redis.ha.xu1.large.r4.24 | + | | | - redis.cluster.xu1.large.r2.48 | + | | | - redis.ha.xu1.large.r2.1 | + | | | - redis.ha.xu1.large.r3.48 | + | | | - redis.single.xu1.large.4 | + | | | - redis.cluster.xu1.large.r4.48 | + | | | - redis.cluster.xu1.large.r3.768 | + | | | - redis.ha.xu1.tiny.r4.128 | + | | | - redis.ha.xu1.large.r5.1 | + | | | - redis.cluster.xu1.large.r2.96 | + | | | - redis.cluster.xu1.large.r3.4 | + | | | - redis.cluster.xu1.large.r1.128 | + | | | - redis.single.xu1.large.2 | + | | | - redis.ha.xu1.tiny.r3.128 | + | | | - redis.cluster.xu1.large.r2.512 | + | | | - redis.cluster.xu1.large.r3.8 | + | | | - redis.cluster.xu1.large.r4.128 | + | | | - redis.cluster.xu1.large.r3.96 | + | | | - redis.ha.xu1.large.r4.8 | + | | | - redis.ha.xu1.large.r5.48 | + | | | - redis.single.xu1.large.8 | + | | | - redis.cluster.xu1.large.r2.24 | + | | | - redis.cluster.xu1.large.r1.4 | + | | | - redis.cluster.xu1.large.r5.32 | + | | | - redis.cluster.xu1.large.r1.64 | + | | | - redis.cluster.xu1.large.r4.96 | + | | | - redis.single.xu1.tiny.256 | + | | | - redis.cluster.xu1.large.r5.128 | + | | | - redis.cluster.xu1.large.r2.16 | + | | | - redis.cluster.xu1.large.r4.8 | + | | | - redis.cluster.xu1.large.r4.512 | + | | | - redis.cluster.xu1.large.r1.384 | + | | | - redis.cluster.xu1.large.r5.768 | + | | | - redis.cluster.xu1.large.r3.256 | + | | | - redis.cluster.xu1.large.r1.256 | + | | | - redis.cluster.xu1.large.r4.64 | + | | | - redis.cluster.xu1.large.r5.256 | + | | | - redis.cluster.xu1.large.r4.384 | + | | | - redis.ha.xu1.tiny.r5.128 | + | | | - redis.cluster.xu1.large.r3.24 | + | | | - redis.cluster.xu1.large.r4.192 | + | | | - redis.cluster.xu1.large.r1.96 | + | | | - redis.ha.xu1.large.r2.2 | + | | | - redis.single.xu1.large.24 | + | | | - redis.ha.xu1.large.r4.4 | + | | | - redis.cluster.xu1.large.r1.1024 | + | | | - redis.ha.xu1.large.r2.16 | + | | | - redis.ha.xu1.large.r4.16 | + | | | - redis.cluster.xu1.large.r5.96 | + | | | - redis.cluster.xu1.large.r5.384 | + | | | - redis.cluster.xu1.large.r3.16 | + | | | - redis.ha.xu1.large.r3.16 | + | | | - redis.ha.xu1.large.r4.32 | + | | | - redis.ha.xu1.tiny.r5.256 | + | | | - redis.single.xu1.large.32 | + | | | - redis.ha.xu1.large.r5.2 | + | | | - redis.cluster.xu1.large.r1.16 | + | | | - redis.cluster.xu1.large.r2.384 | + | | | - redis.cluster.xu1.large.r2.192 | + | | | - redis.cluster.xu1.large.r1.48 | + | | | - redis.ha.xu1.large.r5.8 | + | | | - redis.cluster.xu1.large.r5.16 | + | | | - redis.cluster.xu1.large.r3.128 | + | | | - redis.ha.xu1.large.r3.4 | + | | | - redis.cluster.xu1.large.r1.192 | + | | | - redis.cluster.xu1.large.r3.384 | + | | | - redis.cluster.xu1.large.r2.4 | + | | | - redis.ha.xu1.large.r2.4 | + | | | - redis.single.xu1.tiny.128 | + | | | - redis.cluster.xu1.large.r1.512 | + | | | - redis.ha.xu1.large.r2.64 | + | | | - redis.cluster.xu1.large.r2.128 | + | | | - redis.cluster.xu1.large.r2.768 | + | | | - redis.cluster.xu1.large.r5.64 | + | | | - redis.cluster.xu1.large.r3.48 | + | | | - redis.single.xu1.tiny.512 | + | | | - redis.cluster.xu1.large.r5.48 | + | | | - redis.ha.xu1.large.r4.48 | + | | | - redis.cluster.xu1.large.r4.24 | + | | | - redis.ha.xu1.large.r5.4 | + | | | - redis.ha.xu1.large.r2.8 | + | | | - redis.ha.xu1.large.r3.64 | + | | | - redis.cluster.xu1.large.r2.64 | + | | | - redis.cluster.xu1.large.r2.32 | + | | | - redis.cluster.xu1.large.r4.16 | + | | | - redis.cluster.xu1.large.r4.256 | + | | | - redis.single.xu1.large.1 | + | | | - redis.cluster.xu1.large.r1.8 | + | | | - redis.cluster.xu1.large.r3.32 | + | | | - redis.single.xu1.large.48 | + | | | - redis.cluster.xu1.large.r5.1024 | + | | | - redis.cluster.xu1.large.r3.192 | + | | | - redis.cluster.xu1.large.r2.256 | + | | | - redis.ha.xu1.tiny.r3.256 | + | | | - redis.cluster.xu1.large.r5.24 | + | | | - redis.ha.xu1.tiny.r3.512 | + | | | - redis.cluster.xu1.large.r5.512 | + | | | - redis.ha.xu1.large.r5.32 | + | | | - redis.cluster.xu1.large.r3.64 | + | | | - redis.ha.xu1.large.r2.32 | + | | | - redis.ha.xu1.large.p2.16 | + | | | - redis.ha.xu1.large.p2.32 | + | | | - redis.ha.xu1.large.p2.64 | + | | | - redis.ha.xu1.large.p2.8 | + | | | - redis.ha.xu1.large.p3.16 | + | | | - redis.ha.xu1.large.p3.32 | + | | | - redis.ha.xu1.large.p3.64 | + | | | - redis.ha.xu1.large.p3.8 | + | | | - redis.ha.xu1.large.p4.16 | + | | | - redis.ha.xu1.large.p4.32 | + | | | - redis.ha.xu1.large.p4.64 | + | | | - redis.ha.xu1.large.p4.8 | + | | | - redis.ha.xu1.large.p5.16 | + | | | - redis.ha.xu1.large.p5.32 | + | | | - redis.ha.xu1.large.p5.64 | + | | | - redis.ha.xu1.large.p5.8 | + | | | - redis.ha.xu1.large.p6.16 | + | | | - redis.ha.xu1.large.p6.32 | + | | | - redis.ha.xu1.large.p6.64 | + | | | - redis.ha.xu1.large.p6.8 | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | cache_mode | String | DCS instance type. Options: | + | | | | + | | | - **single**: single-node | + | | | - **ha**: master/standby | + | | | - **cluster**: Redis Cluster | + | | | - **proxy**: Proxy Cluster | + | | | - **ha_rw_split**: read/write splitting | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | product_type | String | Edition of DCS for Redis. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | cpu_type | String | CPU architecture. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | storage_type | String | Storage type. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | details | Array of Object | Details of the specifications. :ref:`Table 3 ` describes the parameters in this array. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine | String | Cache engine. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | engine_versions | String | Cache engine version. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_details | String | DCS specifications. The value subjects to the returned specifications. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | spec_details2 | String | Detailed DCS specifications, including the maximum number of connections and maximum memory size. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | charging_type | String | Billing mode. Value: **Hourly**. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | price | Double | Price of the DCS service to which you can subscribe. (This parameter has been abandoned.) | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | currency | String | Currency. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | prod_type | String | Product type. | + | | | | + | | | Options: **instance** and **obs_space**. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | cloud_service_type_code | String | Cloud service type code. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | cloud_resource_type_code | String | Cloud resource type code. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavors | Array | AZs with available resources. :ref:`Table 4 ` describes the parameters in this array. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | billing_factor | String | Billing item. | + +--------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312040__table830249172716: +.. _dcs-api-0312040__en-us_topic_0166889650_table830249172716: .. table:: **Table 3** details parameter description @@ -282,7 +282,7 @@ Response | db_number | String | Number of DBs of the specifications. | +------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312040__table1979512328317: +.. _dcs-api-0312040__en-us_topic_0166889650_table1979512328317: .. table:: **Table 4** flavors parameter description @@ -298,7 +298,7 @@ Response .. code-block:: - { + { "product_id": "dcs.master_standby-h", "spec_code": "dcs.master_standby", "cache_mode": "ha", @@ -375,9 +375,9 @@ Response Status Code ----------- -:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 5 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312040__table11875348101316: +.. _dcs-api-0312040__en-us_topic_0166889650_table11875348101316: .. table:: **Table 5** Status code diff --git a/api-ref/source/other_apis/querying_the_quota_of_a_tenant.rst b/api-ref/source/outdated_apis_v1/other_apis/querying_the_quota_of_a_tenant.rst similarity index 82% rename from api-ref/source/other_apis/querying_the_quota_of_a_tenant.rst rename to api-ref/source/outdated_apis_v1/other_apis/querying_the_quota_of_a_tenant.rst index 180f5c5..949ef51 100644 --- a/api-ref/source/other_apis/querying_the_quota_of_a_tenant.rst +++ b/api-ref/source/outdated_apis_v1/other_apis/querying_the_quota_of_a_tenant.rst @@ -15,9 +15,9 @@ URI GET /v1.0/{project_id}/quota -:ref:`Table 1 ` describes the parameter. +:ref:`Table 1 ` describes the parameter. -.. _dcs-api-0312036__table13653920143919: +.. _dcs-api-0312036__en-us_topic_0166889657_table13653920143919: .. table:: **Table 1** Parameter description @@ -43,31 +43,31 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312036__table114165246391: +.. _dcs-api-0312036__en-us_topic_0166889657_table114165246391: .. table:: **Table 2** Parameter description - +-----------+--------+-----------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +===========+========+===========+===========================================================================================+ - | quotas | Object | Yes | Quota information. For details, see :ref:`Table 3 `. | - +-----------+--------+-----------+-------------------------------------------------------------------------------------------+ + +-----------+--------+-----------+------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +===========+========+===========+==================================================================================================================+ + | quotas | Object | Yes | Quota information. For details, see :ref:`Table 3 `. | + +-----------+--------+-----------+------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312036__table1341618240392: +.. _dcs-api-0312036__en-us_topic_0166889657_table1341618240392: .. table:: **Table 3** quotas parameter description - +---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +===============+========+===========+============================================================================================================+ - | resources | Array | Yes | List of quotas. For details, see :ref:`Table 4 `. | - +---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+ - | resource_user | Object | Yes | Information about a resource tenant For details, see :ref:`Table 5 `. | - +---------------+--------+-----------+------------------------------------------------------------------------------------------------------------+ + +---------------+--------+-----------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +===============+========+===========+===================================================================================================================================+ + | resources | Array | Yes | List of quotas. For details, see :ref:`Table 4 `. | + +---------------+--------+-----------+-----------------------------------------------------------------------------------------------------------------------------------+ + | resource_user | Object | Yes | Information about a resource tenant For details, see :ref:`Table 5 `. | + +---------------+--------+-----------+-----------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312036__table164180248392: +.. _dcs-api-0312036__en-us_topic_0166889657_table164180248392: .. table:: **Table 4** resources parameter description @@ -95,7 +95,7 @@ Response | | | - Indicates the minimum limit of memory quota when **type** is set to **ram**. | +-----------------------+-----------------------+----------------------------------------------------------------------------------------+ -.. _dcs-api-0312036__table1641811248397: +.. _dcs-api-0312036__en-us_topic_0166889657_table1641811248397: .. table:: **Table 5** resource_user parameter description @@ -140,9 +140,9 @@ Response Status Code ----------- -:ref:`Table 6 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 6 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312036__table597043515135: +.. _dcs-api-0312036__en-us_topic_0166889657_table597043515135: .. table:: **Table 6** Status code diff --git a/api-ref/source/parameter_management_apis/index.rst b/api-ref/source/outdated_apis_v1/parameter_management_apis/index.rst similarity index 100% rename from api-ref/source/parameter_management_apis/index.rst rename to api-ref/source/outdated_apis_v1/parameter_management_apis/index.rst diff --git a/api-ref/source/parameter_management_apis/modifying_configuration_parameters.rst b/api-ref/source/outdated_apis_v1/parameter_management_apis/modifying_configuration_parameters.rst similarity index 76% rename from api-ref/source/parameter_management_apis/modifying_configuration_parameters.rst rename to api-ref/source/outdated_apis_v1/parameter_management_apis/modifying_configuration_parameters.rst index fa7d70e..4ca4ab8 100644 --- a/api-ref/source/parameter_management_apis/modifying_configuration_parameters.rst +++ b/api-ref/source/outdated_apis_v1/parameter_management_apis/modifying_configuration_parameters.rst @@ -15,9 +15,9 @@ URI PUT /v1.0/{project_id}/instances/{instance_id}/configs -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312017__table139152015133712: +.. _dcs-api-0312017__en-us_topic_0166889585_table139152015133712: .. table:: **Table 1** Parameter description @@ -33,9 +33,9 @@ Request **Request parameters** -:ref:`Table 2 ` describes the request parameters. +:ref:`Table 2 ` describes the request parameters. -.. _dcs-api-0312017__table16620132063713: +.. _dcs-api-0312017__en-us_topic_0166889585_table16620132063713: .. table:: **Table 2** Parameter description @@ -45,7 +45,7 @@ Request | redis_config | Array | Yes | Array of configuration items of the DCS instance. | +--------------+-------+-----------+---------------------------------------------------+ -.. _dcs-api-0312017__table35215230340: +.. _dcs-api-0312017__en-us_topic_0166889585_table35215230340: .. table:: **Table 3** redis_config parameter description @@ -57,7 +57,7 @@ Request param_value String Yes Value of the configuration item. =========== ====== ========= ================================ -For possible values of parameters in :ref:`Table 3 `, see :ref:`Table 4 `. +For possible values of parameters in :ref:`Table 3 `, see :ref:`Table 4 `. **Example request** @@ -95,9 +95,9 @@ None Status Code ----------- -:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 4 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312017__table17459195018122: +.. _dcs-api-0312017__en-us_topic_0166889585_table17459195018122: .. table:: **Table 4** Status code diff --git a/api-ref/source/parameter_management_apis/querying_configuration_parameters.rst b/api-ref/source/outdated_apis_v1/parameter_management_apis/querying_configuration_parameters.rst similarity index 98% rename from api-ref/source/parameter_management_apis/querying_configuration_parameters.rst rename to api-ref/source/outdated_apis_v1/parameter_management_apis/querying_configuration_parameters.rst index 7ce174e..08d21af 100644 --- a/api-ref/source/parameter_management_apis/querying_configuration_parameters.rst +++ b/api-ref/source/outdated_apis_v1/parameter_management_apis/querying_configuration_parameters.rst @@ -15,9 +15,9 @@ URI GET /v1.0/{project_id}/instances/{instance_id}/configs -:ref:`Table 1 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. -.. _dcs-api-0312015__table133085233516: +.. _dcs-api-0312015__en-us_topic_0166889603_table133085233516: .. table:: **Table 1** Parameter description @@ -46,9 +46,9 @@ Response **Response parameters** -:ref:`Table 2 ` describes the response parameters. +:ref:`Table 2 ` describes the response parameters. -.. _dcs-api-0312015__table1831432163611: +.. _dcs-api-0312015__en-us_topic_0166889603_table1831432163611: .. table:: **Table 2** Parameter description @@ -59,7 +59,7 @@ Response +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | instance_id | String | DCS instance ID. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | redis_config | Array | Array of configuration items of the DCS instance. For details, see :ref:`Table 3 `. | + | redis_config | Array | Array of configuration items of the DCS instance. For details, see :ref:`Table 3 `. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | config_status | String | DCS instance status that is being modified or has been modified. Options: | | | | | @@ -72,33 +72,33 @@ Response | cluster_v1 | Boolean | Instance type. If **true** is returned, the instance is a Proxy Cluster DCS Redis 3.0 instance. If **false** is returned, the instance is not a Proxy Cluster DCS Redis 3.0 instance. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _dcs-api-0312015__table4967184515317: +.. _dcs-api-0312015__en-us_topic_0166889603_table4967184515317: .. table:: **Table 3** redis_config parameter description - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+========+==================================================================================================================================================================+ - | description | String | Configuration item description. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_id | String | Configuration parameter ID. For the possible values, see the **Parameter ID** column in :ref:`Table 4 `. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_name | String | Configuration parameter name. For the possible values, see the **Parameter Name** column in :ref:`Table 4 `. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_value | String | Configuration parameter value. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | default_value | String | Default value of the configuration parameter. For the possible values, see the **Default Value** column in :ref:`Table 4 `. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | value_type | String | Type of the configuration parameter value. For the possible values, see the **Value Type** column in :ref:`Table 4 `. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | value_range | String | Range of the configuration parameter value. For the possible values, see the **Value Range** column in :ref:`Table 4 `. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | node_role | String | If null or empty is returned, the node is a default node, that is, the Redis Server node. If **proxy** is returned, the node is a proxy node. | - +---------------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===============+========+=========================================================================================================================================================================================+ + | description | String | Configuration item description. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | param_id | String | Configuration parameter ID. For the possible values, see the **Parameter ID** column in :ref:`Table 4 `. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | param_name | String | Configuration parameter name. For the possible values, see the **Parameter Name** column in :ref:`Table 4 `. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | param_value | String | Configuration parameter value. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | default_value | String | Default value of the configuration parameter. For the possible values, see the **Default Value** column in :ref:`Table 4 `. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value_type | String | Type of the configuration parameter value. For the possible values, see the **Value Type** column in :ref:`Table 4 `. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | value_range | String | Range of the configuration parameter value. For the possible values, see the **Value Range** column in :ref:`Table 4 `. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | node_role | String | If null or empty is returned, the node is a default node, that is, the Redis Server node. If **proxy** is returned, the node is a proxy node. | + +---------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -:ref:`Table 4 ` describes the configuration parameters of a DCS instance. +:ref:`Table 4 ` describes the configuration parameters of a DCS instance. -.. _dcs-api-0312015__table1439111281351: +.. _dcs-api-0312015__en-us_topic_0166889603_table1439111281351: .. table:: **Table 4** Configuration parameters of a DCS instance @@ -208,9 +208,9 @@ Response | 30 | reserved-memory-percent | Integer | Percentage of memory reserved for non-cache memory usage. | 0-80 | 0 | +--------------+-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ -:ref:`Table 5 `, :ref:`Table 6 `, :ref:`Table 7 `, :ref:`Table 8 `, :ref:`Table 9 `, and :ref:`Table 10 ` describe the configuration parameters of different DCS instances. +:ref:`Table 5 `, :ref:`Table 6 `, :ref:`Table 7 `, :ref:`Table 8 `, :ref:`Table 9 `, and :ref:`Table 10 ` describe the configuration parameters of different DCS instances. -.. _dcs-api-0312015__table345118121114: +.. _dcs-api-0312015__en-us_topic_0166889603_table345118121114: .. table:: **Table 5** Configuration parameters of a single-node DCS Redis 3.0 instance @@ -282,7 +282,7 @@ Response | | 30 | reserved-memory-percent | Integer | Percentage of memory reserved for non-cache memory usage. | 0-80 | 0 | +-----------------------+--------------+---------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------+ -.. _dcs-api-0312015__table926781142120: +.. _dcs-api-0312015__en-us_topic_0166889603_table926781142120: .. table:: **Table 6** Configuration parameters of a master/standby DCS Redis 3.0 instance @@ -366,7 +366,7 @@ Response | | 30 | reserved-memory-percent | Integer | Percentage of memory reserved for non-cache memory usage. | 0-80 | 0 | +--------------------------+--------------+---------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------+ -.. _dcs-api-0312015__table143241417251: +.. _dcs-api-0312015__en-us_topic_0166889603_table143241417251: .. table:: **Table 7** Configuration parameters of a Proxy Cluster DCS Redis 3.0 instance @@ -386,7 +386,7 @@ Response | | | | | | noeviction | | +-------------------------+--------------+------------------+---------+----------------------------------------------------------------------------------------------------+-----------------+---------------+ -.. _dcs-api-0312015__table1827484732820: +.. _dcs-api-0312015__en-us_topic_0166889603_table1827484732820: .. table:: **Table 8** Configuration parameters of a single-node DCS Redis 4.0 or 5.0 instance @@ -464,7 +464,7 @@ Response | | 23 | master-read-only | String | Sets the instance to be read-only. All write operations will fail. | yes,no | no | +------------------------------+--------------+---------------------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------+ -.. _dcs-api-0312015__table1791611321: +.. _dcs-api-0312015__en-us_topic_0166889603_table1791611321: .. table:: **Table 9** Configuration parameters of a master/standby DCS Redis 4.0 or 5.0 instance @@ -562,7 +562,7 @@ Response | | 26 | client-output-buffer-limit-slave-soft-seconds | Integer | Number of seconds that the output buffer remains above **client-output-buffer-slave-soft-limit** before the client is disconnected. | 0-60 | 60 | +---------------------------------+--------------+-----------------------------------------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------+ -.. _dcs-api-0312015__table1146611119158: +.. _dcs-api-0312015__en-us_topic_0166889603_table1146611119158: .. table:: **Table 10** Configuration parameters of a Redis Cluster DCS Redis 4.0 or 5.0 instance @@ -792,9 +792,9 @@ Response Status Code ----------- -:ref:`Table 11 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. +:ref:`Table 11 ` describes the status code of successful operations. For details about other status codes, see :ref:`Table 1 `. -.. _dcs-api-0312015__table1644239141218: +.. _dcs-api-0312015__en-us_topic_0166889603_table1644239141218: .. table:: **Table 11** Status code