forked from docs/doc-exports
DMS API-REF 20230201 Version
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:
parent
9457035d64
commit
ef239b7410
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/kafka/{instance_id}/tags/action</p>
|
||||
<div class="section" id="BatchCreateOrDeleteKafkaTag__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/kafka/{instance_id}/tags/action</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -89,9 +89,13 @@
|
||||
</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 can contain a maximum of 36 Unicode characters.</p>
|
||||
<p>The key cannot be left blank or be an empty string.</p>
|
||||
<p>It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Tag key, which:</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>
|
||||
</li><li><p>Can contain letters, digits, spaces, and special characters _.:=+-@</p>
|
||||
</li><li><p>Cannot start or end with a space.</p>
|
||||
</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>value</p>
|
||||
@ -100,9 +104,11 @@
|
||||
</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 value, which can contain a maximum of 43 Unicode characters.</p>
|
||||
<p>The value cannot be left blank or be an empty string.</p>
|
||||
<p>It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Tag value.</p>
|
||||
<ul><li><p>Can contain 0 to 255 characters.</p>
|
||||
</li><li><p>Can contain letters, digits, spaces, and special characters _.:=+-@</p>
|
||||
</li><li><p>Cannot start or end with a space.</p>
|
||||
</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -111,7 +117,8 @@
|
||||
</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">POST https://{endpoint}/v2/{project_id}/kafka/{instance_id}/tags/action
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Creating instance tags with tag keys key1 and key2 and tag values value1 and value2</p>
|
||||
<pre class="screen">POST https://{endpoint}/v2/{project_id}/kafka/{instance_id}/tags/action
|
||||
|
||||
{
|
||||
"action" : "create",
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete</p>
|
||||
<div class="section" id="BatchDeleteGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/groups/batch-delete</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -48,13 +48,13 @@
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>[items]</p>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>group_ids</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>Array of strings</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of consumer groups to be deleted.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>IDs of all consumer groups to be deleted.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -115,9 +115,12 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Batch deleting consumer groups</p>
|
||||
<pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups/batch-delete
|
||||
|
||||
[ "group1", "group2" ]</pre>
|
||||
{
|
||||
"group_ids" : [ "get-sync-group0", "get-sync-group1" ]
|
||||
}</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
||||
<p>The consumer groups are deleted successfully.</p>
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
<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 consumer groups are deleted successfully while some fail to be deleted, a success response is returned with information about consumer groups that fail to be deleted.</p>
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/topics/delete</p>
|
||||
<div class="section" id="BatchDeleteInstanceTopic__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/topics/delete</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>
|
||||
@ -21,7 +21,9 @@
|
||||
</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 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>
|
||||
@ -31,6 +33,8 @@
|
||||
<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>
|
||||
@ -54,7 +58,8 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of strings</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>List of topics to delete.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Topics to delete.</p>
|
||||
<p>This parameter is mandatory when instance topics are deleted in batches.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -108,7 +113,8 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/delete
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Batch deleting topics</p>
|
||||
<pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/delete
|
||||
|
||||
{
|
||||
"topics" : [ "topic01" ]
|
||||
@ -118,10 +124,7 @@
|
||||
<p>The deletion is successful.</p>
|
||||
<pre class="screen">{
|
||||
"topics" : [ {
|
||||
"id" : "haha",
|
||||
"success" : true
|
||||
}, {
|
||||
"id" : "aabb",
|
||||
"id" : "topic01",
|
||||
"success" : true
|
||||
} ]
|
||||
}</pre>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/users</p>
|
||||
<div class="section" id="BatchDeleteInstanceUsers__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/users</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -55,6 +55,7 @@
|
||||
<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>Deletion type. Currently, only <strong>delete</strong> is supported.</p>
|
||||
<p>This parameter is mandatory for deleting a user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>users</p>
|
||||
@ -64,6 +65,7 @@
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Array of strings</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User list.</p>
|
||||
<p>This parameter is mandatory for deleting a user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/action</p>
|
||||
<div class="section" id="BatchRestartOrDeleteInstances__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/action</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>
|
||||
@ -23,7 +23,7 @@
|
||||
</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 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>
|
||||
</tbody>
|
||||
@ -166,6 +166,11 @@
|
||||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>The instances are restarted or deleted successfully.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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>All Kafka instances that fail to be created are deleted successfully.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
618
docs/dms/api-ref/CreateInstanceByEngine.html
Normal file
618
docs/dms/api-ref/CreateInstanceByEngine.html
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/users</p>
|
||||
<div class="section" id="CreateInstanceUser__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/users</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -55,6 +55,18 @@
|
||||
<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>Username.</p>
|
||||
<p>This parameter is mandatory for creating a user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>user_desc</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
|
||||
</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>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>
|
||||
@ -63,14 +75,15 @@
|
||||
</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>User password.</p>
|
||||
<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>
|
||||
<ul><li><p>Contains 8 to 32 characters.</p>
|
||||
</li><li><p>Contains at least two of the following character types:</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>
|
||||
</li><li><p>Uppercase letters</p>
|
||||
</li><li><p>Digits</p>
|
||||
</li><li><p>Special characters `~!@#$%^&*()-_=+|[{}]:'"",<.>/?</p>
|
||||
</li><li><p>Special characters include (`~!@#$ %^&*()-_=+|[{}]:'",<.>/?) and spaces, and cannot start with a hyphen (-).</p>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</td>
|
||||
@ -134,12 +147,12 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Creating a user.</p>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Creating a user whose username is test and password is Cxxx3</p>
|
||||
<pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users
|
||||
|
||||
{
|
||||
"user_name" : "test",
|
||||
"user_passwd" : "Cloud@123"
|
||||
"user_passwd" : "Cxxx3"
|
||||
}</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
278
docs/dms/api-ref/CreateReassignmentTask.html
Normal file
278
docs/dms/api-ref/CreateReassignmentTask.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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="section" id="DeleteBackgroundTask__atuogenerate_1"><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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -50,7 +50,8 @@
|
||||
</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 class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting a specified background task</p>
|
||||
<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>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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="section" id="DeleteGroup__atuogenerate_1"><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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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="section" id="DeleteInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/instances/{instance_id}</p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
|
||||
</th>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -41,7 +41,8 @@
|
||||
</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 class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting an instance</p>
|
||||
<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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/tasks</p>
|
||||
<div class="section" id="ListBackgroundTasks__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/tasks</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
|
||||
565
docs/dms/api-ref/ListEngineProducts.html
Normal file
565
docs/dms/api-ref/ListEngineProducts.html
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
233
docs/dms/api-ref/ListTopicPartitions.html
Normal file
233
docs/dms/api-ref/ListTopicPartitions.html
Normal file
File diff suppressed because it is too large
Load Diff
209
docs/dms/api-ref/ListTopicProducers.html
Normal file
209
docs/dms/api-ref/ListTopicProducers.html
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,9 +1,9 @@
|
||||
<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><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"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/management/groups/{group}/reset-message-offset</p>
|
||||
<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>
|
||||
|
||||
<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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -59,7 +59,7 @@
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>topic</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||
</td>
|
||||
@ -68,7 +68,7 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>partition</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
|
||||
<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>Integer</p>
|
||||
</td>
|
||||
@ -79,7 +79,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Resetting consumer group offset to the specified position.</p>
|
||||
<ul><li><p>If this position is earlier than the current earliest offset, the offset will be reset to the earliest offset.</p>
|
||||
@ -92,7 +92,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Specified time that the offset is to be reset to. The value is a Unix timestamp, in millisecond.</p>
|
||||
<ul><li><p>If this time is earlier than the current earliest timestamp, the offset will be reset to the earliest timestamp.</p>
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
<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.</p>
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/password</p>
|
||||
<div class="section" id="ResetPassword__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/instances/{instance_id}/password</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -50,7 +50,7 @@
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>new_password</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
|
||||
<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>String</p>
|
||||
</td>
|
||||
@ -68,7 +68,8 @@
|
||||
</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">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/password
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Resetting a password</p>
|
||||
<pre class="screen">POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/password
|
||||
|
||||
{
|
||||
"new_password" : "********"
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}</p>
|
||||
<div class="section" id="ResetUserPasswrod__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/instances/{instance_id}/users/{user_name}</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -64,6 +64,16 @@
|
||||
<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>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>
|
||||
<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>
|
||||
</li><li><p>Uppercase letters</p>
|
||||
</li><li><p>Digits</p>
|
||||
</li><li><p>Special characters include (`~!@#$ %^&*()-_=+|[{}]:'",<.>/?) and spaces, and cannot start with a hyphen (-).</p>
|
||||
</li></ul>
|
||||
</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -76,7 +86,7 @@
|
||||
<pre class="screen">PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}
|
||||
|
||||
{
|
||||
"new_password" : "Cloud@123"
|
||||
"new_password" : "Cxxx3"
|
||||
}</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
|
||||
|
||||
222
docs/dms/api-ref/ResizeEngineInstance.html
Normal file
222
docs/dms/api-ref/ResizeEngineInstance.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}</p>
|
||||
<div class="section" id="ShowBackgroundTask__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy</p>
|
||||
<div class="section" id="ShowCesHierarchy__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/ces-hierarchy</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -332,7 +332,7 @@
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/ces-hierarchy</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
||||
<p>The information is listed successfully.</p>
|
||||
<p>Query succeeded.</p>
|
||||
<pre class="screen">{
|
||||
"dimensions" : [ {
|
||||
"name" : "kafka_instance_id",
|
||||
@ -424,7 +424,7 @@
|
||||
</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 information is listed successfully.</p>
|
||||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Query succeeded.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/cluster</p>
|
||||
<div class="section" id="ShowCluster__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/cluster</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/coordinators</p>
|
||||
<div class="section" id="ShowCoordinators__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/coordinators</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
|
||||
614
docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html
Normal file
614
docs/dms/api-ref/ShowEngineInstanceExtendProductInfo.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/groups/{group}</p>
|
||||
<div class="section" id="ShowGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -179,7 +179,7 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>lag</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Number of remaining messages that can be retrieved, that is, the number of accumulated messages.</p>
|
||||
</td>
|
||||
@ -193,14 +193,14 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>message_current_offset</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Consumer offset.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>message_log_end_offset</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Log end offset (LEO).</p>
|
||||
</td>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}</p>
|
||||
<div class="section" id="ShowGroups__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -212,7 +212,7 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p>lag</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p>Number of remaining messages that can be retrieved, that is, the number of accumulated messages.</p>
|
||||
</td>
|
||||
@ -226,14 +226,14 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p>message_current_offset</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p>Consumer offset.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p>message_log_end_offset</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p>Log end offset (LEO).</p>
|
||||
</td>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
240
docs/dms/api-ref/ShowInstanceConfigs.html
Normal file
240
docs/dms/api-ref/ShowInstanceConfigs.html
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/messages</p>
|
||||
<div class="section" id="ShowInstanceMessages__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/messages</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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>Tenant's project ID.</p>
|
||||
<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>
|
||||
@ -94,7 +94,7 @@
|
||||
</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>Page size. The value ranges from 0 to 50.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Number of messages displayed on each page.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>offset</p>
|
||||
@ -103,7 +103,7 @@
|
||||
</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>Offset, which is the position where the query starts. The value must be greater than or equal to 0.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Page number.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>download</p>
|
||||
@ -137,6 +137,17 @@
|
||||
<p>If <strong>start_time</strong> and <strong>end_time</strong> are not empty, this parameter is invalid.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>keyword</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</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>Keyword. The value ranges from 0 to 50.</p>
|
||||
<p>Minimum: <strong>0</strong></p>
|
||||
<p>Maximum: <strong>50</strong></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@ -171,7 +182,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Number of messages.</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Number of records on each page.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -225,7 +236,7 @@
|
||||
</td>
|
||||
<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>Topic name.</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Message production time. The value is a UNIX timestamp, in ms.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>huge_message</p>
|
||||
@ -237,7 +248,7 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>message_offset</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
|
||||
<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>Message offset.</p>
|
||||
</td>
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
<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.</p>
|
||||
<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>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}</p>
|
||||
<div class="section" id="ShowInstanceTopicDetail__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/management/topics/{topic}</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -184,7 +184,7 @@
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p>lag</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p>Integer</p>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p>Long</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Number of messages that lag behind the high watermark in the replica.</p>
|
||||
</td>
|
||||
@ -193,7 +193,8 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}</pre>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying details about a specified topic</p>
|
||||
<pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/topics/{topic}</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
||||
<p>The query is successful.</p>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<div><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"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/users</p>
|
||||
<div class="section" id="ShowInstanceUsers__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/users</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>
|
||||
@ -22,7 +22,7 @@
|
||||
</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 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>
|
||||
@ -74,6 +74,14 @@
|
||||
<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>Username.</p>
|
||||
<p>A username must start with a letter. It can contain 4 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>user_desc</p>
|
||||
</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>User description.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>role</p>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<h1 class="topictitle1">Listing Tags of a Project</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query project tags.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/kafka/tags</p>
|
||||
<div class="section" id="ShowKafkaProjectTags__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/kafka/tags</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
</tbody>
|
||||
@ -63,18 +63,14 @@
|
||||
</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 can contain a maximum of 36 Unicode characters.</p>
|
||||
<p>The key cannot be left blank or be an empty string.</p>
|
||||
<p>It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>values</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of strings</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag value, which can contain a maximum of 43 Unicode characters.</p>
|
||||
<p>The value cannot be left blank or be an empty string.</p>
|
||||
<p>It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag value.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<h1 class="topictitle1">Listing Tags of an Instance</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query instance tags.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/kafka/{instance_id}/tags</p>
|
||||
<div class="section" id="ShowKafkaTags__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/kafka/{instance_id}/tags</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -72,18 +72,24 @@
|
||||
</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 can contain a maximum of 36 Unicode characters.</p>
|
||||
<p>The key cannot be left blank or be an empty string.</p>
|
||||
<p>It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key, which:</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>
|
||||
</li><li><p>Can contain letters, digits, spaces, and special characters _.:=+-@</p>
|
||||
</li><li><p>Cannot start or end with a space.</p>
|
||||
</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>value</p>
|
||||
</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 value, which can contain a maximum of 43 Unicode characters.</p>
|
||||
<p>The value cannot be left blank or be an empty string.</p>
|
||||
<p>It cannot contain nonprintable ASCII (0–31) characters and the following special characters: =*<>,|/</p>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag value.</p>
|
||||
<ul><li><p>Can contain 0 to 255 characters.</p>
|
||||
</li><li><p>Can contain letters, digits, spaces, and special characters _.:=+-@</p>
|
||||
</li><li><p>Cannot start or end with a space.</p>
|
||||
</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<h1 class="topictitle1">Querying the Disk Usage Status of Topics</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the broker disk usage of topics.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/topics/diskusage</p>
|
||||
<div class="section" id="ShowKafkaTopicPartitionDiskusage__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/instances/{instance_id}/topics/diskusage</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>
|
||||
@ -21,7 +21,7 @@
|
||||
</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 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>
|
||||
@ -202,7 +202,8 @@
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/diskusage</pre>
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying the disk usage status of topics</p>
|
||||
<pre class="screen">GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics/diskusage</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
||||
<p>The query is successful.</p>
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
<h1 class="topictitle1">Listing Maintenance Time Windows</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the start time and end time of maintenance time windows.</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/instances/maintain-windows</p>
|
||||
<div class="section" id="ShowMaintainWindows__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v2/instances/maintain-windows</p>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
|
||||
</div>
|
||||
@ -71,7 +71,7 @@
|
||||
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{endpoint}/v2/instances/maintain-windows</pre>
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
|
||||
<p>The consumption of the message is successfully acknowledged.</p>
|
||||
<p>Query succeeded.</p>
|
||||
<pre class="screen">{
|
||||
"maintain_windows" : [ {
|
||||
"default" : false,
|
||||
@ -115,7 +115,7 @@
|
||||
</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 consumption of the message is successfully acknowledged.</p>
|
||||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Query succeeded.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
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