DCS API 20230220 Version

Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

docs/dcs/api-ref/BackgroudTasksManagement.html

@@ -0,0 +1,22 @@
+<a name="BackgroudTasksManagement"></a><a name="BackgroudTasksManagement"></a>
+
+<h1 class="topictitle1">Background Task Management</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="ListBackgroundTask.html">Listing Background Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteBackgroundTask.html">Deleting a Background Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowJobInfo.html">Querying the Job Execution Result of a Tenant</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteCenterTask.html">Deleting a Task in the Task Center</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/BackupRestoreManagement.html

@@ -0,0 +1,26 @@
+<a name="BackupRestoreManagement"></a><a name="BackupRestoreManagement"></a>
+
+<h1 class="topictitle1">Backup and Restoration</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="DeleteBackupFile.html">Deleting Backup Files</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="RestoreInstance.html">Restoring a DCS Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListRestoreRecords.html">Querying DCS Instance Restoration Records</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListBackupFileLinks.html">Obtaining the Backup File URL</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="CopyInstance.html">Backing Up a DCS Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListBackupRecords.html">Listing DCS Instance Backup Records</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/CacheAnalysisManagement.html

@@ -0,0 +1,40 @@
+<a name="CacheAnalysisManagement"></a><a name="CacheAnalysisManagement"></a>
+
+<h1 class="topictitle1">Cache Analysis</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="CreateBigkeyScanTask.html">Creating a Big Key Analysis Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListBigkeyScanTasks.html">Listing Big Key Analysis Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowBigkeyScanTaskDetails.html">Querying Big Key Analysis Details</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteBigkeyScanTask.html">Deleting a Big Key Analysis Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="UpdateBigkeyAutoscanConfig.html">Configuring Automatic Big Key Analysis</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowBigkeyAutoscanConfig.html">Querying the Configurations of Automatic Big Key Analysis</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="CreateHotkeyScanTask.html">Creating a Hot Key Analysis Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListHotKeyScanTasks.html">Listing Hot Key Analysis Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowHotkeyTaskDetails.html">Querying Hot Key Analysis Details</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteHotkeyScanTask.html">Deleting a Hot Key Analysis Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="UpdateHotkeyAutoScanConfig.html">Configuring Automatic Hot Key Analysis</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowHotkeyAutoscanConfig.html">Querying the Configurations of Automatic Hot Key Analysis</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="CreateAutoExpireScanTask.html">Creating an Expired Key Scan Task</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/ConfigTemplatesManagement.html

@@ -0,0 +1,18 @@
+<a name="ConfigTemplatesManagement"></a><a name="ConfigTemplatesManagement"></a>
+
+<h1 class="topictitle1">Template Management</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="ListConfigTemplates.html">Viewing Parameter Templates</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="CreateCustomTemplate.html">Creating a Custom Template</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/DataMigrationManagement.html

@@ -0,0 +1,34 @@
+<a name="DataMigrationManagement"></a><a name="DataMigrationManagement"></a>
+
+<h1 class="topictitle1">Data Migration</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="CreateMigrationTask.html">Creating a Backup Import Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListMigrationTask.html">Listing Migration Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteMigrationTask.html">Deleting Data Migration Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowMigrationTask.html">Querying Details of a Data Migration Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="UpdateMigrationTask.html">Configuring Auto-Reconnect for Migration Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="StopMigrationTask.html">Stopping a Data Migration Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowMigrationTaskStats.html">Querying the Progress of an Online Migration Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="CreateOnlineMigrationTask.html">Creating an Online Data Migration Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="SetOnlineMigrationTask.html">Configuring an Online Data Migration Task</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="BatchStopMigrationTasks.html">Stopping Data Migration Tasks</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/DeleteSingleInstance.html

@@ -0,0 +1,85 @@
+<a name="DeleteSingleInstance"></a><a name="DeleteSingleInstance"></a>
+
+<h1 class="topictitle1">Deleting an Instance</h1>
+<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a specified DCS instance to free up all resources occupied by it.</p>
+<div class="note"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p>To delete pay-per-use resources, perform operations in this section..</p>
+</div></div>
+</div>
+<div class="section" id="DeleteSingleInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}</p>
+
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
+</td>
+<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
+</td>
+</tr>
+<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>instance_id</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
+</td>
+<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Instance ID.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
+</div>
+<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
+</div>
+<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting a specified instance</p>
+<pre class="screen">DELETE https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}</pre>
+</div>
+<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
+</div>
+<div class="section"><h4 class="sectiontitle">Status Codes</h4>
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteSingleInstance__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>204</p>
+</td>
+<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Instance deleted successfully.</p>
+</td>
+</tr>
+<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>400</p>
+</td>
+<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Invalid request.</p>
+</td>
+</tr>
+<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>500</p>
+</td>
+<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Internal service error.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="LifecycleManagement.html">Lifecycle Management</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/GroupReplicationManagement.html

@@ -0,0 +1,22 @@
+<a name="GroupReplicationManagement"></a><a name="GroupReplicationManagement"></a>
+
+<h1 class="topictitle1">Shards and Replicas</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="UpdateSlavePriority.html">Configuring Replica Priority</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteIpFromDomainName.html">Removing the IP Address</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListGroupReplicationInfo.html">Querying Details of Shards</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="BatchShowNodesInformation.html">Querying Instance Nodes in Batches</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/InstanceDiagnosisManagement.html

@@ -0,0 +1,18 @@
+<a name="InstanceDiagnosisManagement"></a><a name="InstanceDiagnosisManagement"></a>
+
+<h1 class="topictitle1">Instance Diagnosis</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="ListDiagnosisTasks.html">Listing Instance Diagnosis Tasks</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowDiagnosisTaskDetails.html">Querying a Specified Diagnosis Report</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/InstanceManagement.html

@@ -0,0 +1,22 @@
+<a name="InstanceManagement"></a><a name="InstanceManagement"></a>
+
+<h1 class="topictitle1">Instance Management</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="ChangeMasterStandby.html">Master/Standby Switchover</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="UpdatePassword.html">Changing the Password</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="RestartOrFlushInstances.html">Restarting DCS Instances or Clearing DCS Instance Data</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListStatisticsOfRunningInstances.html">Querying Statistics of All Running Instances</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+

docs/dcs/api-ref/LifecycleManagement.html

@@ -0,0 +1,28 @@
+<a name="LifecycleManagement"></a><a name="LifecycleManagement"></a>
+
+<h1 class="topictitle1">Lifecycle Management</h1>
+<div><p>    </p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="CreateInstance.html">Creating a DCS Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ListInstances.html">Querying All DCS Instances</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="BatchDeleteInstances.html">Batch Deleting DCS Instances</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ShowInstance.html">Querying a DCS instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="DeleteSingleInstance.html">Deleting an Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="UpdateInstance.html">Modifying Details of a DCS Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ResizeInstance.html">Modifying Instance Specifications</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0605001.html">APIs V2 (Recommended)</a></div>
+</div>
+</div>
+