forked from docs/doc-exports
DMS API-REF Initial Version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
This commit is contained in:
parent
dd8a3a658b
commit
7f68b84da4
812
docs/dms/api-ref/ALL_META.TXT.json
Normal file
812
docs/dms/api-ref/ALL_META.TXT.json
Normal file
File diff suppressed because it is too large
Load Diff
153
docs/dms/api-ref/BatchCleanupInstanceTopic.html
Normal file
153
docs/dms/api-ref/BatchCleanupInstanceTopic.html
Normal file
File diff suppressed because it is too large
Load Diff
153
docs/dms/api-ref/BatchCreateOrDeleteKafkaTag.html
Normal file
153
docs/dms/api-ref/BatchCreateOrDeleteKafkaTag.html
Normal file
File diff suppressed because it is too large
Load Diff
159
docs/dms/api-ref/BatchDeleteGroup.html
Normal file
159
docs/dms/api-ref/BatchDeleteGroup.html
Normal file
File diff suppressed because it is too large
Load Diff
153
docs/dms/api-ref/BatchDeleteInstanceTopic.html
Normal file
153
docs/dms/api-ref/BatchDeleteInstanceTopic.html
Normal file
File diff suppressed because it is too large
Load Diff
109
docs/dms/api-ref/BatchDeleteInstanceUsers.html
Normal file
109
docs/dms/api-ref/BatchDeleteInstanceUsers.html
Normal file
File diff suppressed because it is too large
Load Diff
181
docs/dms/api-ref/BatchRestartOrDeleteInstances.html
Normal file
181
docs/dms/api-ref/BatchRestartOrDeleteInstances.html
Normal file
File diff suppressed because it is too large
Load Diff
731
docs/dms/api-ref/CLASS.TXT.json
Normal file
731
docs/dms/api-ref/CLASS.TXT.json
Normal file
File diff suppressed because it is too large
Load Diff
166
docs/dms/api-ref/CreateInstanceTopic.html
Normal file
166
docs/dms/api-ref/CreateInstanceTopic.html
Normal file
File diff suppressed because it is too large
Load Diff
181
docs/dms/api-ref/CreateInstanceUser.html
Normal file
181
docs/dms/api-ref/CreateInstanceUser.html
Normal file
File diff suppressed because it is too large
Load Diff
107
docs/dms/api-ref/CreatePartition.html
Normal file
107
docs/dms/api-ref/CreatePartition.html
Normal file
File diff suppressed because it is too large
Load Diff
479
docs/dms/api-ref/CreatePostPaidInstance.html
Normal file
479
docs/dms/api-ref/CreatePostPaidInstance.html
Normal file
File diff suppressed because it is too large
Load Diff
81
docs/dms/api-ref/DeleteBackgroundTask.html
Normal file
81
docs/dms/api-ref/DeleteBackgroundTask.html
Normal file
@ -0,0 +1,81 @@
|
||||
<a name="DeleteBackgroundTask"></a><a name="DeleteBackgroundTask"></a>
|
||||
|
||||
<h1 class="topictitle1">Deleting a Background Task</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a specified background task.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_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.</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>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>task_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>Task 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><pre class="screen">DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_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="DeleteBackgroundTask__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>The background task is deleted successfully.</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="topic_300000007.html">Background Task Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
81
docs/dms/api-ref/DeleteGroup.html
Normal file
81
docs/dms/api-ref/DeleteGroup.html
Normal file
@ -0,0 +1,81 @@
|
||||
<a name="DeleteGroup"></a><a name="DeleteGroup"></a>
|
||||
|
||||
<h1 class="topictitle1">Deleting a Consumer Group from a Kafka Instance</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a consumer group from a Kafka instance.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}</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.</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>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>group</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>Consumer group 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><pre class="screen">DELETE https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/{group}</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="DeleteGroup__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>The deletion is successful.</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="topic_300000001.html">Instance Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
72
docs/dms/api-ref/DeleteInstance.html
Normal file
72
docs/dms/api-ref/DeleteInstance.html
Normal file
@ -0,0 +1,72 @@
|
||||
<a name="DeleteInstance"></a><a name="DeleteInstance"></a>
|
||||
|
||||
<h1 class="topictitle1">Deleting an Instance</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete an instance to release all the resources occupied by it.</p>
|
||||
</div>
|
||||
<div class="section"><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.</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><pre class="screen">DELETE https://{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="DeleteInstance__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>The specified instance is deleted successfully.</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="topic_300000000.html">Lifecycle Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
1790
docs/dms/api-ref/ErrorCode.html
Normal file
1790
docs/dms/api-ref/ErrorCode.html
Normal file
File diff suppressed because it is too large
Load Diff
166
docs/dms/api-ref/ListAvailableZones.html
Normal file
166
docs/dms/api-ref/ListAvailableZones.html
Normal file
File diff suppressed because it is too large
Load Diff
239
docs/dms/api-ref/ListBackgroundTasks.html
Normal file
239
docs/dms/api-ref/ListBackgroundTasks.html
Normal file
File diff suppressed because it is too large
Load Diff
160
docs/dms/api-ref/ListInstanceConsumerGroups.html
Normal file
160
docs/dms/api-ref/ListInstanceConsumerGroups.html
Normal file
File diff suppressed because it is too large
Load Diff
230
docs/dms/api-ref/ListInstanceTopics.html
Normal file
230
docs/dms/api-ref/ListInstanceTopics.html
Normal file
File diff suppressed because it is too large
Load Diff
687
docs/dms/api-ref/ListInstances.html
Normal file
687
docs/dms/api-ref/ListInstances.html
Normal file
File diff suppressed because it is too large
Load Diff
646
docs/dms/api-ref/ListProducts_0.html
Normal file
646
docs/dms/api-ref/ListProducts_0.html
Normal file
File diff suppressed because it is too large
Load Diff
3
docs/dms/api-ref/PARAMETERS.txt
Normal file
3
docs/dms/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
154
docs/dms/api-ref/ResetMessageOffset.html
Normal file
154
docs/dms/api-ref/ResetMessageOffset.html
Normal file
File diff suppressed because it is too large
Load Diff
103
docs/dms/api-ref/ResetPassword.html
Normal file
103
docs/dms/api-ref/ResetPassword.html
Normal file
File diff suppressed because it is too large
Load Diff
108
docs/dms/api-ref/ResetUserPasswrod.html
Normal file
108
docs/dms/api-ref/ResetUserPasswrod.html
Normal file
File diff suppressed because it is too large
Load Diff
159
docs/dms/api-ref/ResizeInstance.html
Normal file
159
docs/dms/api-ref/ResizeInstance.html
Normal file
File diff suppressed because it is too large
Load Diff
189
docs/dms/api-ref/ShowBackgroundTask.html
Normal file
189
docs/dms/api-ref/ShowBackgroundTask.html
Normal file
File diff suppressed because it is too large
Load Diff
442
docs/dms/api-ref/ShowCesHierarchy.html
Normal file
442
docs/dms/api-ref/ShowCesHierarchy.html
Normal file
File diff suppressed because it is too large
Load Diff
257
docs/dms/api-ref/ShowCluster.html
Normal file
257
docs/dms/api-ref/ShowCluster.html
Normal file
File diff suppressed because it is too large
Load Diff
150
docs/dms/api-ref/ShowCoordinators.html
Normal file
150
docs/dms/api-ref/ShowCoordinators.html
Normal file
File diff suppressed because it is too large
Load Diff
284
docs/dms/api-ref/ShowGroup.html
Normal file
284
docs/dms/api-ref/ShowGroup.html
Normal file
File diff suppressed because it is too large
Load Diff
322
docs/dms/api-ref/ShowGroups.html
Normal file
322
docs/dms/api-ref/ShowGroups.html
Normal file
File diff suppressed because it is too large
Load Diff
597
docs/dms/api-ref/ShowInstance.html
Normal file
597
docs/dms/api-ref/ShowInstance.html
Normal file
File diff suppressed because it is too large
Load Diff
763
docs/dms/api-ref/ShowInstanceExtendProductInfo.html
Normal file
763
docs/dms/api-ref/ShowInstanceExtendProductInfo.html
Normal file
File diff suppressed because it is too large
Load Diff
383
docs/dms/api-ref/ShowInstanceMessages.html
Normal file
383
docs/dms/api-ref/ShowInstanceMessages.html
Normal file
File diff suppressed because it is too large
Load Diff
308
docs/dms/api-ref/ShowInstanceTopicDetail.html
Normal file
308
docs/dms/api-ref/ShowInstanceTopicDetail.html
Normal file
File diff suppressed because it is too large
Load Diff
152
docs/dms/api-ref/ShowInstanceUsers.html
Normal file
152
docs/dms/api-ref/ShowInstanceUsers.html
Normal file
File diff suppressed because it is too large
Load Diff
122
docs/dms/api-ref/ShowKafkaProjectTags.html
Normal file
122
docs/dms/api-ref/ShowKafkaProjectTags.html
Normal file
File diff suppressed because it is too large
Load Diff
131
docs/dms/api-ref/ShowKafkaTags.html
Normal file
131
docs/dms/api-ref/ShowKafkaTags.html
Normal file
File diff suppressed because it is too large
Load Diff
295
docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html
Normal file
295
docs/dms/api-ref/ShowKafkaTopicPartitionDiskusage.html
Normal file
File diff suppressed because it is too large
Load Diff
133
docs/dms/api-ref/ShowMaintainWindows.html
Normal file
133
docs/dms/api-ref/ShowMaintainWindows.html
Normal file
File diff suppressed because it is too large
Load Diff
241
docs/dms/api-ref/ShowMessages.html
Normal file
241
docs/dms/api-ref/ShowMessages.html
Normal file
File diff suppressed because it is too large
Load Diff
138
docs/dms/api-ref/ShowPartitionBeginningMessage.html
Normal file
138
docs/dms/api-ref/ShowPartitionBeginningMessage.html
Normal file
File diff suppressed because it is too large
Load Diff
138
docs/dms/api-ref/ShowPartitionEndMessage.html
Normal file
138
docs/dms/api-ref/ShowPartitionEndMessage.html
Normal file
File diff suppressed because it is too large
Load Diff
206
docs/dms/api-ref/ShowPartitionMessage.html
Normal file
206
docs/dms/api-ref/ShowPartitionMessage.html
Normal file
File diff suppressed because it is too large
Load Diff
167
docs/dms/api-ref/ShowTopicAccessPolicy.html
Normal file
167
docs/dms/api-ref/ShowTopicAccessPolicy.html
Normal file
File diff suppressed because it is too large
Load Diff
176
docs/dms/api-ref/UpdateInstance.html
Normal file
176
docs/dms/api-ref/UpdateInstance.html
Normal file
File diff suppressed because it is too large
Load Diff
99
docs/dms/api-ref/UpdateInstanceAutoCreateTopic.html
Normal file
99
docs/dms/api-ref/UpdateInstanceAutoCreateTopic.html
Normal file
@ -0,0 +1,99 @@
|
||||
<a name="UpdateInstanceAutoCreateTopic"></a><a name="UpdateInstanceAutoCreateTopic"></a>
|
||||
|
||||
<h1 class="topictitle1">Configuring Automatic Topic Creation</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to enable or disable automatic topic creation.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/autotopic</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.</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>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceAutoCreateTopic__request_UpdateInstanceAutoCreateTopicReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p>Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p>Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>enable_auto_topic</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Boolean</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Whether to enable automatic topic creation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Enabling automatic topic creation.</p>
|
||||
<pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/autotopic
|
||||
|
||||
{
|
||||
"enable_auto_topic" : true
|
||||
}</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="UpdateInstanceAutoCreateTopic__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>200</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>The function is enabled or disabled successfully.</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="topic_300000001.html">Instance Management</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
183
docs/dms/api-ref/UpdateInstanceCrossVpcIp.html
Normal file
183
docs/dms/api-ref/UpdateInstanceCrossVpcIp.html
Normal file
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user