vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

DMS API 20240722 version

Browse Source 
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
This commit is contained in:
Chen, Junjie 2024-09-06 09:17:23 +00:00 committed by zuul
parent d97aea4dd2
commit f5b629cc78
73 changed files with 3767 additions and 508 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

334
docs/dms/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

4
docs/dms/api-ref/BatchCreateOrDeleteKafkaTag.html
View File

@ -1,7 +1,7 @@
<a name="BatchCreateOrDeleteKafkaTag"></a><a name="BatchCreateOrDeleteKafkaTag"></a>
<h1 class="topictitle1">Batch Adding or Deleting Tags</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add or delete instance tags in batches.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add or delete instance tags in batches.</p>
</div>
<div class="section" id="BatchCreateOrDeleteKafkaTag__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/kafka/{instance_id}/tags/action</p>
@ -89,7 +89,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Tag key, which:</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Tag key.</p>
<ul><li><p>Must be specified.</p>
</li><li><p>Must be unique for the same instance.</p>
</li><li><p>Can contain 1 to 128 characters.</p>

4
docs/dms/api-ref/BatchDeleteGroup.html
View File

@ -1,7 +1,7 @@
<a name="BatchDeleteGroup"></a><a name="BatchDeleteGroup"></a>
<h1 class="topictitle1">Batch Deleting Consumer Groups of a Kafka Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete multiple consumer groups of a Kafka instance in batches.</p>
<h1 class="topictitle1">Deleting Consumer Groups of a Kafka Instance in Batches</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete multiple consumer groups of a Kafka instance in batches.</p>
</div>
<div class="section" id="BatchDeleteGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete</p>

6
docs/dms/api-ref/BatchDeleteInstanceTopic.html
View File

@ -1,7 +1,7 @@
<a name="BatchDeleteInstanceTopic"></a><a name="BatchDeleteInstanceTopic"></a>
<h1 class="topictitle1">Batch Deleting Topics of a Kafka Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is returned with information about topics that fail to be deleted.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete multiple topics of a Kafka instance in batches. If some topics are deleted successfully while some fail to be deleted, a success response is returned with information about topics that fail to be deleted.</p>
</div>
<div class="section" id="BatchDeleteInstanceTopic__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/topics/delete</p>
@ -22,8 +22,6 @@
<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 about how to obtain it, see <a href="kafka-api-0036212547.html">Obtaining a Project ID</a>.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>instance_id</p>
@ -33,8 +31,6 @@
<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>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
</tbody>

2
docs/dms/api-ref/BatchDeleteInstanceUsers.html
View File

@ -1,7 +1,7 @@
<a name="BatchDeleteInstanceUsers"></a><a name="BatchDeleteInstanceUsers"></a>
<h1 class="topictitle1">Deleting Users in Batches</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete multiple users of a Kafka instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete multiple users of a Kafka instance.</p>
</div>
<div class="section" id="BatchDeleteInstanceUsers__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/users</p>

2
docs/dms/api-ref/BatchRestartOrDeleteInstances.html
View File

@ -1,7 +1,7 @@
<a name="BatchRestartOrDeleteInstances"></a><a name="BatchRestartOrDeleteInstances"></a>
<h1 class="topictitle1">Batch Restarting or Deleting Instances</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to restart or delete instances in batches.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to restart or delete instances in batches.</p>
<p>When an instance is being restarted, message retrieval and creation requests of the client will be rejected.</p>
<p>Deleting an instance will delete the data in the instance without any backup. Exercise caution when performing this operation.</p>
</div>

328
docs/dms/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

158
docs/dms/api-ref/CreateConnector.html Normal file
View File

File diff suppressed because it is too large Load Diff

1062
docs/dms/api-ref/CreateConnectorTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

39
docs/dms/api-ref/CreateInstanceByEngine.html
View File

File diff suppressed because it is too large Load Diff

24
docs/dms/api-ref/CreateInstanceTopic.html
View File

@ -1,7 +1,7 @@
<a name="CreateInstanceTopic"></a><a name="CreateInstanceTopic"></a>
<h1 class="topictitle1">Creating a Topic for a Kafka Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a topic for a Kafka instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a topic for a Kafka instance.</p>
</div>
<div class="section" id="CreateInstanceTopic__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/topics</p>
@ -22,8 +22,6 @@
<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 about how to obtain it, see <a href="kafka-api-0036212547.html">Obtaining a Project ID</a>.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>instance_id</p>
@ -33,8 +31,6 @@
<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>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
</tbody>
@ -59,8 +55,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Topic name. A topic name consists of 3 to 200 characters, starts with a letter, and contains only letters, hyphens (-), underscores (_), periods (.), and digits.</p>
<p>Minimum: <strong>3</strong></p>
<p>Maximum: <strong>200</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>replication</p>
@ -69,9 +63,8 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Number of replicas, which is configured to ensure data reliability. Value range: 1 to 3.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>3</strong></p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Number of replicas, which is configured to ensure data reliability.</p>
<p>Value range: 1 to 3.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>sync_message_flush</p>
@ -89,9 +82,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: 1–100.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>100</strong></p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Number of topic partitions, which is used to set the number of concurrently consumed messages.Value range: 1–200</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>sync_replication</p>
@ -109,7 +100,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Indicates the retention period of a message. The default value is <strong>72</strong>.Value range: 1–720. Unit: hour.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Indicates the retention period of a message. The default value is <strong>72</strong>.The value range is 1–720, in hours.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>topic_other_configs</p>
@ -119,7 +110,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of <a href="#CreateInstanceTopic__request_topic_other_configs">topic_other_configs</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Topic configuration.</p>
<p>Array Length: <strong>0 - 100</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>topic_desc</p>
@ -129,8 +119,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Topic description.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>200</strong></p>
</td>
</tr>
</tbody>
@ -184,8 +172,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Topic name.</p>
<p>Minimum: <strong>3</strong></p>
<p>Maximum: <strong>200</strong></p>
</td>
</tr>
</tbody>

7
docs/dms/api-ref/CreateInstanceUser.html
View File

@ -1,7 +1,7 @@
<a name="CreateInstanceUser"></a><a name="CreateInstanceUser"></a>
<h1 class="topictitle1">Creating a User</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a user for a Kafka instance for which SASL is enabled.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a user for a Kafka instance for which SASL is enabled.</p>
</div>
<div class="section" id="CreateInstanceUser__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/users</p>
@ -65,8 +65,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User description.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>200</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>user_passwd</p>
@ -77,7 +75,8 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Password.</p>
<p>This parameter is mandatory for creating a user.</p>
<p>The password must be different from the username. The password must meet the following complexity requirements:</p>
<p>The password must be different from the username.</p>
<p>The password must meet the following complexity requirements:</p>
<ul><li><p>Can contain 8 to 32 characters.</p>
</li><li><p>Must contain at least three of the following character types:</p>
<ul><li><p>Lowercase letters</p>

40
docs/dms/api-ref/CreateKafkaConsumerGroup.html
View File

@ -1,7 +1,7 @@
<a name="CreateKafkaConsumerGroup"></a><a name="CreateKafkaConsumerGroup"></a>
<h1 class="topictitle1">Creating a Consumer Group</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a consumer group.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a consumer group.</p>
</div>
<div class="section" id="CreateKafkaConsumerGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/kafka/instances/{instance_id}/group</p>
@ -64,17 +64,15 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Consumer group description.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>200</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 400</strong></p>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateKafkaConsumerGroup__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateKafkaConsumerGroup__response_CreateGroupResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -82,18 +80,40 @@
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>error_code</p>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>-</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Error code.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Specified IPv4 private IP addresses.</p>
<p>The number of specified IP addresses must be less than or equal to the number of new brokers.</p>
<p>If the number of specified IP addresses is less than the number of brokers, the unspecified brokers are randomly assigned private IP addresses.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>error_msg</p>
</tbody>
</table>
</div>
<p><strong>Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateKafkaConsumerGroup__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p>error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Error description.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Error code.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p>error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Error description.</p>
</td>
</tr>
</tbody>

3
docs/dms/api-ref/CreateReassignmentTask.html
View File

@ -1,7 +1,7 @@
<a name="CreateReassignmentTask"></a><a name="CreateReassignmentTask"></a>
<h1 class="topictitle1">Initiating Partition Reassigning for a Kafka Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to submit a partition rebalancing task to a Kafka instance or calculate estimated rebalancing time.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to submit a partition rebalancing task to a Kafka instance or calculate estimated rebalancing time.</p>
</div>
<div class="section" id="CreateReassignmentTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/kafka/{project_id}/instances/{instance_id}/reassign</p>
@ -91,7 +91,6 @@
<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>Set <strong>true</strong> to perform time estimation tasks and <strong>false</strong> to perform rebalancing tasks.</p>
<p>Default: <strong>false</strong></p>
</td>
</tr>
</tbody>

2
docs/dms/api-ref/DeleteBackgroundTask.html
View File

@ -1,7 +1,7 @@
<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 id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a specified background task.</p>
</div>
<div class="section" id="DeleteBackgroundTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}/tasks/{task_id}</p>

95
docs/dms/api-ref/DeleteConnector.html Normal file
View File

@ -0,0 +1,95 @@
<a name="DeleteConnector"></a><a name="DeleteConnector"></a>
<h1 class="topictitle1">Disabling Smart Connect (Pay-per-Use Instance)</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to disable Smart Connect for a pay-per-use instance.</p>
</div>
<div class="section" id="DeleteConnector__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/kafka/instances/{instance_id}/delete-connector</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 about how to obtain it, see <a href="kafka-api-0036212547.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><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteConnector__response_DeleteConnectorResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>ID of the job for asynchronously executing the deletion task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/delete-connector</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Smart Connect disabling task submitted successfully.</p>
<pre class="screen">{
"job_id" : "d366178c-29ea-4d5c-a344-fa2ece4a1836"
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteConnector__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>Smart Connect disabling task submitted 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_300000011.html">Smart Connect</a></div>
</div>
</div>

81
docs/dms/api-ref/DeleteConnectorTask.html Normal file
View File

@ -0,0 +1,81 @@
<a name="DeleteConnectorTask"></a><a name="DeleteConnectorTask"></a>
<h1 class="topictitle1">Deleting a Smart Connect Task</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a Smart Connect task.</p>
</div>
<div class="section" id="DeleteConnectorTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}/connector/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. For details, see <a href="kafka-api-0036212547.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>
<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>Smart Connect 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}/connector/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="DeleteConnectorTask__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>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_300000011.html">Smart Connect</a></div>
</div>
</div>

2
docs/dms/api-ref/DeleteGroup.html
View File

@ -1,7 +1,7 @@
<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 id="body1708331107508"><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" id="DeleteGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}/groups/{group}</p>

2
docs/dms/api-ref/DeleteInstance.html
View File

@ -1,7 +1,7 @@
<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 id="body1708331107508"><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" id="DeleteInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}</p>

28
docs/dms/api-ref/ErrorCode.html
View File

@ -1,7 +1,7 @@
<a name="ErrorCode_1"></a><a name="ErrorCode_1"></a>
<h1 class="topictitle1">Error Codes</h1>
<div>
<div id="body1708331141525">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ErrorCode_1__ErrorCode" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.1.1.6.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.1.1.6.1.2"><p>Error Codes</p>
@ -605,9 +605,9 @@ A password:
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p>DMS.00400102</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p>The number of partitions created for a Kafka topic must be within the range of 1-20.</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p>The number of partitions created for a Kafka topic must be within the range of 1-200.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p>The number of partitions created for a topic in a Kafka instance must be within the range of 1-20.</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p>The number of partitions created for a topic in a Kafka instance must be within the range of 1-200.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.1.6.1.5 "><p>Check the number of partitions of the topic.</p>
</td>
@ -834,6 +834,17 @@ A password:
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.1.6.1.1 "><p>400</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p>DMS.00400975</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p>Failed to query topics.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p>Failed to query topics.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.1.6.1.5 "><p>Check whether the topic exists.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.1.6.1.1 "><p>400</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p>DMS.00404033</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p>Does not support extend rabbitMQ disk space.</p>
@ -1769,6 +1780,17 @@ A password:
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.1.6.1.1 "><p>500</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p>DMS.00500990</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p>Failed to update topics.</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p>Failed to update topics.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.1.6.1.5 "><p>Contact technical support.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.1.6.1.1 "><p>500</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p>DMS.00501000</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p>Failed to create agency, may be you do not have the agency permission.</p>

2
docs/dms/api-ref/ListAvailableZones.html
View File

@ -1,7 +1,7 @@
<a name="ListAvailableZones"></a><a name="ListAvailableZones"></a>
<h1 class="topictitle1">Listing AZ Information</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the AZ ID for creating an instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the AZ ID for creating an instance.</p>
</div>
<div class="section" id="ListAvailableZones__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/available-zones</p>
</div>

2
docs/dms/api-ref/ListBackgroundTasks.html
View File

@ -1,7 +1,7 @@
<a name="ListBackgroundTasks"></a><a name="ListBackgroundTasks"></a>
<h1 class="topictitle1">Listing Background Tasks</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to list background tasks of an instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to list background tasks of an instance.</p>
</div>
<div class="section" id="ListBackgroundTasks__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/tasks</p>

635
docs/dms/api-ref/ListConnectorTasks.html Normal file
View File

File diff suppressed because it is too large Load Diff

5
docs/dms/api-ref/ListEngineProducts.html
View File

@ -1,7 +1,7 @@
<a name="ListEngineProducts"></a><a name="ListEngineProducts"></a>
<h1 class="topictitle1">Querying Product Specifications List</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the product specifications list.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the product specifications list.</p>
</div>
<div class="section" id="ListEngineProducts__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{engine}/products</p>
@ -22,7 +22,6 @@
<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>Message engine.</p>
<p>Default: <strong>kafka</strong></p>
</td>
</tr>
</tbody>
@ -342,6 +341,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>The product specifications are listed successfully.</p>
<ul><li><p>Successful.</p>
<pre class="screen">{
"engine" : "kafka",
"versions" : [ "1.1.0", "2.3.0" ],
@ -537,6 +537,7 @@
}
} ]
}</pre>
</li></ul>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListEngineProducts__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>

2
docs/dms/api-ref/ListInstanceConsumerGroups.html
View File

@ -1,7 +1,7 @@
<a name="ListInstanceConsumerGroups"></a><a name="ListInstanceConsumerGroups"></a>
<h1 class="topictitle1">Querying All Consumer Groups</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query all consumer groups.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query all consumer groups.</p>
</div>
<div class="section" id="ListInstanceConsumerGroups__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/groups</p>

2
docs/dms/api-ref/ListInstanceTopics.html
View File

@ -1,7 +1,7 @@
<a name="ListInstanceTopics"></a><a name="ListInstanceTopics"></a>
<h1 class="topictitle1">Listing Topics of a Kafka Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query details about topics of a Kafka instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query details about topics of a Kafka instance.</p>
</div>
<div class="section" id="ListInstanceTopics__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/topics</p>

36
docs/dms/api-ref/ListInstances.html
View File

@ -1,7 +1,7 @@
<a name="ListInstances"></a><a name="ListInstances"></a>
<h1 class="topictitle1">Listing All Instances</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the instances of an account by the specified conditions.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the instances of an account by the specified conditions.</p>
</div>
<div class="section" id="ListInstances__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances</p>
@ -40,12 +40,11 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>engine</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Message engine. Value: <strong>kafka</strong>.</p>
<p>Default: <strong>kafka</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>name</p>
@ -72,7 +71,8 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Instance status. For details, see <a href="kafka-api-180514012.html">Instance Status</a>.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Instance status.</p>
<p>For details, see <a href="kafka-api-180514012.html">Instance Status</a>.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>include_failure</p>
@ -252,7 +252,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Resource specification code.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Resource specifications.</p>
<ul><li><p><strong>dms.instance.kafka.cluster.c3.mini</strong>: Kafka instance with 100 MB/s bandwidth</p>
</li><li><p><strong>dms.instance.kafka.cluster.c3.small.2</strong>: Kafka instance with 300 MB/s bandwidth</p>
</li><li><p><strong>dms.instance.kafka.cluster.c3.middle.2</strong>: Kafka instance with 600 MB/s bandwidth</p>
@ -521,13 +521,6 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Public network access bandwidth.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>kafka_manager_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Whether Kafka Manager is enabled.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>new_auth_cert</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Boolean</p>
@ -542,6 +535,13 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Cross-VPC access information.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>connector_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Whether dumping is enabled. Dumping is not supported for the new specification type.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>connector_node_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
@ -595,7 +595,13 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Time when public access was enabled for an instance. The value can be <strong>true</strong>, <strong>actived</strong>, <strong>closed</strong>, or <strong>false</strong>.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Time when public access was enabled for an instance.</p>
<p>Value range:</p>
<ul><li><p><strong>true</strong>: enabled</p>
</li><li><p><strong>actived</strong>: disabled</p>
</li><li><p><strong>closed</strong>: disabled</p>
</li><li><p><strong>false</strong>: disabled</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>node_num</p>
@ -656,7 +662,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Tag key, which:</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Tag key.</p>
<ul><li><p>Must be specified.</p>
</li><li><p>Must be unique for the same instance.</p>
</li><li><p>Can contain 1 to 128 characters.</p>
@ -710,8 +716,6 @@
"user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"user_name" : "paas_dms",
"access_user" : "root",
"kafka_manager_enable" : false,
"kafka_manager_user" : "root",
"maintain_begin" : "02:00:00",
"maintain_end" : "06:00:00",
"enable_log_collection" : false,

25
docs/dms/api-ref/ListTopicPartitions.html
View File

File diff suppressed because it is too large Load Diff

21
docs/dms/api-ref/ListTopicProducers.html
View File

@ -1,7 +1,7 @@
<a name="ListTopicProducers"></a><a name="ListTopicProducers"></a>
<h1 class="topictitle1">Querying the Current Producer List of a Topic</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the current producer list of a topic.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the current producer list of a topic.</p>
</div>
<div class="section" id="ListTopicProducers__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/kafka/instances/{instance_id}/topics/{topic}/producers</p>
@ -22,8 +22,6 @@
<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 about how to obtain it, see <a href="kafka-api-0036212547.html">Obtaining a Project ID</a>.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>instance_id</p>
@ -33,8 +31,6 @@
<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>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>topic</p>
@ -44,8 +40,6 @@
<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>Topic.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>200</strong></p>
</td>
</tr>
</tbody>
@ -69,8 +63,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Offset. The records after this offset will be queried.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>10000</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>limit</p>
@ -80,8 +72,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Maximum number of records that can be returned.</p>
<p>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>50</strong></p>
</td>
</tr>
</tbody>
@ -105,8 +95,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Total records.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>10000</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>producers</p>
@ -114,7 +102,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListTopicProducers__response_producers">producers</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Producer list.</p>
<p>Array Length: <strong>0 - 50</strong></p>
</td>
</tr>
</tbody>
@ -134,8 +121,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Producer address.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>broker_address</p>
@ -143,8 +128,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Broker address.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>join_time</p>
@ -152,8 +135,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Time when the broker was connected.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>9223372036854775807</strong></p>
</td>
</tr>
</tbody>

2
docs/dms/api-ref/ModifyInstanceConfigs.html
View File

@ -1,7 +1,7 @@
<a name="ModifyInstanceConfigs"></a><a name="ModifyInstanceConfigs"></a>
<h1 class="topictitle1">Modifying Instance Configurations</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to modify instance configurations.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to modify instance configurations.</p>
</div>
<div class="section" id="ModifyInstanceConfigs__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/configs</p>

81
docs/dms/api-ref/PauseConnectorTask.html Normal file
View File

@ -0,0 +1,81 @@
<a name="PauseConnectorTask"></a><a name="PauseConnectorTask"></a>
<h1 class="topictitle1">Pausing a Smart Connect Task</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to pause a Smart Connect task.</p>
</div>
<div class="section" id="PauseConnectorTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pause</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="kafka-api-0036212547.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>
<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>Smart Connect 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">PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/pause</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="PauseConnectorTask__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>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_300000011.html">Smart Connect</a></div>
</div>
</div>

2
docs/dms/api-ref/ResetMessageOffset.html
View File

@ -1,7 +1,7 @@
<a name="ResetMessageOffset"></a><a name="ResetMessageOffset"></a>
<h1 class="topictitle1">Resetting Consumer Group Offset to the Specified Position</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset.After a client is stopped, the server considers the client offline only after the time period specified in <strong>ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG</strong> (1000 ms by default).</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>Kafka instances do not support resetting the consumer offset online. Before resetting, stop the client for which the offset is to be reset.After a client is stopped, the server considers the client offline only after the time period specified in <strong>ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG</strong> (1000 ms by default).</p>
</div>
<div class="section" id="ResetMessageOffset__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset</p>

2
docs/dms/api-ref/ResetPassword.html
View File

@ -1,7 +1,7 @@
<a name="ResetPassword"></a><a name="ResetPassword"></a>
<h1 class="topictitle1">Resetting the Password</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to reset the password for an instance with SSL enabled.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to reset the password for an instance with SSL enabled.</p>
</div>
<div class="section" id="ResetPassword__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/password</p>

5
docs/dms/api-ref/ResetUserPasswrod.html
View File

@ -1,7 +1,7 @@
<a name="ResetUserPasswrod"></a><a name="ResetUserPasswrod"></a>
<h1 class="topictitle1">Resetting a User Password</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to reset a user password.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to reset a user password.</p>
</div>
<div class="section" id="ResetUserPasswrod__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}</p>
@ -65,7 +65,8 @@
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>New password.</p>
<p>This parameter is mandatory for resetting a user password.</p>
<p>It cannot be the username or the username spelled backwards. The password must meet the following complexity requirements:</p>
<p>It cannot be the username or the username spelled backwards.</p>
<p>The password must meet the following complexity requirements:</p>
<ul><li><p>Can contain 8 to 32 characters.</p>
</li><li><p>Must contain at least three of the following character types:</p>
<ul><li><p>Lowercase letters</p>

12
docs/dms/api-ref/ResizeEngineInstance.html
View File

@ -1,7 +1,7 @@
<a name="ResizeEngineInstance"></a><a name="ResizeEngineInstance"></a>
<h1 class="topictitle1">Increasing Instance Specifications</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to modify instance specifications.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to modify instance specifications.</p>
</div>
<div class="section" id="ResizeEngineInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{engine}/{project_id}/instances/{instance_id}/extend</p>
@ -22,7 +22,6 @@
<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>Message engine.</p>
<p>Default: <strong>kafka</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
@ -64,11 +63,11 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Type of the change.</p>
<p>Value:</p>
<ul><li><p><strong>storage</strong>: Expand the storage space without adding brokers.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Change type.</p>
<p>Value range:</p>
<ul><li><p><strong>storage</strong>: Expand the storage without changing the broker quantity.</p>
</li><li><p><strong>horizontal</strong>: Add brokers without resizing the storage space of each broker.</p>
</li><li><p><strong>vertical</strong>: Modify the underlying flavor of brokers without adding brokers or storage space.</p>
</li><li><p><strong>vertical</strong>: Scale up the broker flavor without changing the broker quantity and storage.</p>
</li></ul>
</td>
</tr>
@ -92,7 +91,6 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>This parameter is valid only when <strong>oper_type</strong> is set to <strong>horizontal</strong>.</p>
<p>A maximum of 30 brokers are supported.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>new_product_id</p>

81
docs/dms/api-ref/RestartConnectorTask.html Normal file
View File

@ -0,0 +1,81 @@
<a name="RestartConnectorTask"></a><a name="RestartConnectorTask"></a>
<h1 class="topictitle1">Starting a Smart Connect Task or Restarting a Paused or Running Smart Connect Task</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to <strong>start a Smart Connect task</strong> or <strong>restart a paused or running Smart Connect task</strong>. Note that the sync progress will reset and the task will restart.</p>
</div>
<div class="section" id="RestartConnectorTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/kafka/instances/{instance_id}/connector/tasks/{task_id}/restart</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="kafka-api-0036212547.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>
<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>Smart Connect 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">PUT https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/connector/tasks/{task_id}/restart</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="RestartConnectorTask__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>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_300000011.html">Smart Connect</a></div>
</div>
</div>

81
docs/dms/api-ref/ResumeConnectorTask.html Normal file
View File

@ -0,0 +1,81 @@
<a name="ResumeConnectorTask"></a><a name="ResumeConnectorTask"></a>
<h1 class="topictitle1">Restarting a Smart Connect Task</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to restart a Smart Connect task.</p>
</div>
<div class="section" id="ResumeConnectorTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resume</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="kafka-api-0036212547.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>
<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>Smart Connect 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">PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/connector/tasks/{task_id}/resume</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="ResumeConnectorTask__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>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_300000011.html">Smart Connect</a></div>
</div>
</div>

2
docs/dms/api-ref/ShowBackgroundTask.html
View File

@ -1,7 +1,7 @@
<a name="ShowBackgroundTask"></a><a name="ShowBackgroundTask"></a>
<h1 class="topictitle1">Querying a Background Task</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a specified background task.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a specified background task.</p>
</div>
<div class="section" id="ShowBackgroundTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}</p>

2
docs/dms/api-ref/ShowCesHierarchy.html
View File

@ -1,7 +1,7 @@
<a name="ShowCesHierarchy"></a><a name="ShowCesHierarchy"></a>
<h1 class="topictitle1">Querying Kafka Instance Monitoring Dimensions</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query Kafka instance monitoring dimensions.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query Kafka instance monitoring dimensions.</p>
</div>
<div class="section" id="ShowCesHierarchy__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy</p>

2
docs/dms/api-ref/ShowCluster.html
View File

@ -1,7 +1,7 @@
<a name="ShowCluster"></a><a name="ShowCluster"></a>
<h1 class="topictitle1">Querying Kafka Cluster Metadata</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query Kafka cluster metadata.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query Kafka cluster metadata.</p>
</div>
<div class="section" id="ShowCluster__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/cluster</p>

513
docs/dms/api-ref/ShowConnectorTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/dms/api-ref/ShowCoordinators.html
View File

@ -1,7 +1,7 @@
<a name="ShowCoordinators"></a><a name="ShowCoordinators"></a>
<h1 class="topictitle1">Querying Coordinator Details of a Kafka Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query coordinator details of a Kafka instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query coordinator details of a Kafka instance.</p>
</div>
<div class="section" id="ShowCoordinators__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/coordinators</p>

5
docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html
View File

@ -1,7 +1,7 @@
<a name="ShowEngineInstanceExtendProductInfo"></a><a name="ShowEngineInstanceExtendProductInfo"></a>
<h1 class="topictitle1">Querying Product Information for Instance Specification Modification</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the product information for instance specification modification.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the product information for instance specification modification.</p>
</div>
<div class="section" id="ShowEngineInstanceExtendProductInfo__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{engine}/{project_id}/instances/{instance_id}/extend</p>
@ -22,7 +22,6 @@
<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>Message engine.</p>
<p>Default: <strong>kafka</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
@ -337,6 +336,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Successfully queried the product information for instance specification modification.</p>
<ul><li><p>Product information for instance specification modification queried.</p>
<pre class="screen">{
"engine" : "kafka",
"versions" : [ "1.1.0", "2.7" ],
@ -586,6 +586,7 @@
"unavailable_zones" : [ ]
} ]
}</pre>
</li></ul>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowEngineInstanceExtendProductInfo__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>

2
docs/dms/api-ref/ShowGroup.html
View File

@ -1,7 +1,7 @@
<a name="ShowGroup"></a><a name="ShowGroup"></a>
<h1 class="topictitle1">Querying a Specific Consumer Group</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a specific consumer group.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query a specific consumer group.</p>
</div>
<div class="section" id="ShowGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/groups/{group}</p>

2
docs/dms/api-ref/ShowGroups.html
View File

@ -1,7 +1,7 @@
<a name="ShowGroups"></a><a name="ShowGroups"></a>
<h1 class="topictitle1">Querying Consumer Group Details</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query consumer group details.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query consumer group details.</p>
</div>
<div class="section" id="ShowGroups__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}</p>

30
docs/dms/api-ref/ShowInstance.html
View File

@ -1,7 +1,7 @@
<a name="ShowInstance"></a><a name="ShowInstance"></a>
<h1 class="topictitle1">Querying an Instance</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the details about a specified instance.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the details about a specified instance.</p>
</div>
<div class="section" id="ShowInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}</p>
@ -137,7 +137,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Resource specification code.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Resource specifications.</p>
<ul><li><p><strong>dms.instance.kafka.cluster.c3.mini</strong>: Kafka instance with 100 MB/s bandwidth</p>
</li><li><p><strong>dms.instance.kafka.cluster.c3.small.2</strong>: Kafka instance with 300 MB/s bandwidth</p>
</li><li><p><strong>dms.instance.kafka.cluster.c3.middle.2</strong>: Kafka instance with 600 MB/s bandwidth</p>
@ -406,13 +406,6 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Public network access bandwidth.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>kafka_manager_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Whether Kafka Manager is enabled.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>new_auth_cert</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
@ -427,6 +420,13 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Cross-VPC access information.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>connector_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Whether dumping is enabled. Dumping is not supported for the new specification type.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>connector_node_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
@ -480,7 +480,13 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Time when public access was enabled for an instance. The value can be <strong>true</strong>, <strong>actived</strong>, <strong>closed</strong>, or <strong>false</strong>.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Time when public access was enabled for an instance.</p>
<p>Value range:</p>
<ul><li><p><strong>true</strong>: enabled</p>
</li><li><p><strong>actived</strong>: disabled</p>
</li><li><p><strong>closed</strong>: disabled</p>
</li><li><p><strong>false</strong>: disabled</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>node_num</p>
@ -541,7 +547,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key, which:</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key.</p>
<ul><li><p>Must be specified.</p>
</li><li><p>Must be unique for the same instance.</p>
</li><li><p>Can contain 1 to 128 characters.</p>
@ -595,8 +601,6 @@
"user_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"user_name" : "paas_dms",
"access_user" : "root",
"kafka_manager_enable" : false,
"kafka_manager_user" : "root",
"maintain_begin" : "02:00:00",
"maintain_end" : "06:00:00",
"enable_log_collection" : false,

2
docs/dms/api-ref/ShowInstanceConfigs.html
View File

@ -1,7 +1,7 @@
<a name="ShowInstanceConfigs"></a><a name="ShowInstanceConfigs"></a>
<h1 class="topictitle1">Obtaining Instance Configurations</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to obtain instance configurations.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to obtain instance configurations.</p>
</div>
<div class="section" id="ShowInstanceConfigs__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/configs</p>

8
docs/dms/api-ref/ShowInstanceMessages.html
View File

@ -1,7 +1,8 @@
<a name="ShowInstanceMessages"></a><a name="ShowInstanceMessages"></a>
<h1 class="topictitle1">Querying Messages</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the offset and content of a message. This API queries the message offset based on the timestamp and then queries the message content based on the offset.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the offset and content of a message.</p>
<p>This API queries the message offset based on the timestamp and then queries the message content based on the offset.</p>
</div>
<div class="section" id="ShowInstanceMessages__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/messages</p>
@ -143,9 +144,8 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Keyword. The value ranges from 0 to 50.</p>
<p>Minimum: <strong>0</strong></p>
<p>Maximum: <strong>50</strong></p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Keyword.</p>
<p>The value ranges from 0 to 50.</p>
</td>
</tr>
</tbody>

2
docs/dms/api-ref/ShowInstanceTopicDetail.html
View File

@ -1,7 +1,7 @@
<a name="ShowInstanceTopicDetail"></a><a name="ShowInstanceTopicDetail"></a>
<h1 class="topictitle1">Querying Topic Details</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query topic details of a Kafka instance. (Up to 1s for each instance call)</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query topic details of a Kafka instance. (Up to 1s for each instance call)</p>
</div>
<div class="section" id="ShowInstanceTopicDetail__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}</p>

2
docs/dms/api-ref/ShowInstanceUsers.html
View File

@ -1,7 +1,7 @@
<a name="ShowInstanceUsers"></a><a name="ShowInstanceUsers"></a>
<h1 class="topictitle1">Querying the User List</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the user list.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the user list.</p>
<p>User management is supported only when SASL is enabled for the Kafka instance.</p>
</div>
<div class="section" id="ShowInstanceUsers__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/users</p>

Some files were not shown because too many files have changed in this diff Show More