Update content

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 <listbackgroundtask_0>`
+-  :ref:`Deleting a Background Task <deletebackgroundtask_0>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   listing_background_tasks
+   deleting_a_background_task

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 <deletebackupfile_0>`
+-  :ref:`Restoring a DCS Instance <restoreinstance_0>`
+-  :ref:`Querying DCS Instance Restoration Records <listrestorerecords_0>`
+-  :ref:`Obtaining the Backup File URL <listbackupfilelinks_0>`
+-  :ref:`Backing Up a DCS Instance <copyinstance_0>`
+-  :ref:`Listing DCS Instance Backup Records <listbackuprecords_0>`
+
+.. 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

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 <createbigkeyscantask_0>`
+-  :ref:`Listing Big Key Analysis Tasks <listbigkeyscantasks_0>`
+-  :ref:`Querying Big Key Analysis Details <showbigkeyscantaskdetails_0>`
+-  :ref:`Deleting a Big Key Analysis Task <deletebigkeyscantask_0>`
+-  :ref:`Configuring Automatic Big Key Analysis <updatebigkeyautoscanconfig_0>`
+-  :ref:`Querying the Configurations of Automatic Big Key Analysis <showbigkeyautoscanconfig_0>`
+-  :ref:`Creating a Hot Key Analysis Task <createhotkeyscantask_0>`
+-  :ref:`Listing Hot Key Analysis Tasks <listhotkeyscantasks_0>`
+-  :ref:`Querying Hot Key Analysis Details <showhotkeytaskdetails_0>`
+-  :ref:`Deleting a Hot Key Analysis Task <deletehotkeyscantask_0>`
+-  :ref:`Configuring Automatic Hot Key Analysis <updatehotkeyautoscanconfig_0>`
+-  :ref:`Querying the Configurations of Automatic Hot Key Analysis <showhotkeyautoscanconfig_0>`
+-  :ref:`Creating an Expired Key Scan Task <createautoexpirescantask>`
+
+.. 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

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 <createmigrationtask_0>`
+-  :ref:`Listing Migration Tasks <listmigrationtask_0>`
+-  :ref:`Deleting Data Migration Tasks <deletemigrationtask_0>`
+-  :ref:`Querying Details of a Data Migration Task <showmigrationtask_0>`
+-  :ref:`Stopping a Data Migration Task <stopmigrationtask_0>`
+-  :ref:`Querying the Progress of an Online Migration Task <showmigrationtaskstats_0>`
+-  :ref:`Creating an Online Data Migration Task <createonlinemigrationtask_0>`
+-  :ref:`Configuring an Online Data Migration Task <setonlinemigrationtask_0>`
+-  :ref:`Stopping Data Migration Tasks <batchstopmigrationtasks_0>`
+-  :ref:`Stopping Synchronization of a Data Migration Task <stopmigrationtasksync_0>`
+
+.. 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

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 <lifecyclemanagement_0>`
+-  :ref:`Instance Management <instancemanagement_0>`
+-  :ref:`Shards and Replicas <groupreplicationmanagement_0>`
+-  :ref:`Parameter Management <parammanagement_0>`
+-  :ref:`Backup and Restoration <backuprestoremanagement_0>`
+-  :ref:`Data Migration <datamigrationmanagement_0>`
+-  :ref:`Tag Management <tagmanagement>`
+-  :ref:`Cache Analysis <cacheanalysismanagement_0>`
+-  :ref:`Log Management <logmanagement_0>`
+-  :ref:`Network Security <networksecuritymanagement_0>`
+-  :ref:`Background Task Management <backgroudtasksmanagement_0>`
+-  :ref:`Template Management <configtemplatesmanagement_0>`
+-  :ref:`Other APIs <otherinterface_0>`
+
+.. 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

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 <changemasterstandby_0>`
+-  :ref:`Changing the Password <updatepassword_0>`
+-  :ref:`Resetting a Password <resetpassword_0>`
+-  :ref:`Restarting DCS Instances or Clearing DCS Instance Data <restartorflushinstances_0>`
+-  :ref:`Querying Statistics of All Running Instances <liststatisticsofrunninginstances_0>`
+-  :ref:`Modifying the Bandwidth of an Instance <updateinstancebandwidth_0>`
+
+.. 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

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 <errorcode>`.

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 <createinstance_0>`
+-  :ref:`Querying All DCS Instances <listinstances_0>`
+-  :ref:`Batch Deleting DCS Instances <batchdeleteinstances_0>`
+-  :ref:`Querying a DCS instance <showinstance_0>`
+-  :ref:`Deleting an Instance <deletesingleinstance_0>`
+-  :ref:`Modifying Details of a DCS Instance <updateinstance_0>`
+-  :ref:`Modifying Instance Specifications <resizeinstance_0>`
+
+.. 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