forked from docs/doc-exports
DIS API 20230116 version
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
This commit is contained in:
parent
3b672beb23
commit
83fa2f6615
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/stream/{stream_id}/tags/action</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/stream/{stream_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -54,8 +54,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -78,9 +78,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Operation to be performed. The value can be create only.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Operation to be performed. The value can only be <strong>create</strong>, which indicates batch creation.</p>
|
||||||
<ul><li><p>create: batch creation</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>create</strong></p>
|
<ul><li><p><strong>create</strong></p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
@ -115,10 +113,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Key.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Key</p>
|
||||||
<ul><li><p>This field cannot be left blank.</p>
|
<ul><li><p>It cannot be left blank.</p>
|
||||||
</li><li><p>The key value of a resource must be unique.</p>
|
</li><li><p>It must be unique for each resource.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>1</strong></p>
|
<p>Minimum: <strong>1</strong></p>
|
||||||
<p>Maximum: <strong>36</strong></p>
|
<p>Maximum: <strong>36</strong></p>
|
||||||
@ -130,10 +128,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Value.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Value</p>
|
||||||
<ul><li><p>The value contains a maximum of 43 characters.</p>
|
<ul><li><p>It can contain a maximum of 43 characters.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li><li><p>The value can contain only digits, letters, hyphens (-), and underscores (_).</p>
|
</li><li><p>It can only contain digits, letters, hyphens (-), and underscores (_).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>0</strong></p>
|
<p>Minimum: <strong>0</strong></p>
|
||||||
<p>Maximum: <strong>43</strong></p>
|
<p>Maximum: <strong>43</strong></p>
|
||||||
@ -185,3 +183,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/stream/{stream_id}/tags/action</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/stream/{stream_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -54,8 +54,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -78,9 +77,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Operation to be performed. The value can be delete only.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Operation to be performed. The value can only be <strong>delete</strong>, which indicates batch deletion.</p>
|
||||||
<ul><li><p>delete: batch deletion</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>delete</strong></p>
|
<ul><li><p><strong>delete</strong></p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
@ -115,10 +112,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Key.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Key</p>
|
||||||
<ul><li><p>This field cannot be left blank.</p>
|
<ul><li><p>It cannot be left blank.</p>
|
||||||
</li><li><p>The key value of a resource must be unique.</p>
|
</li><li><p>It must be unique for each resource.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>1</strong></p>
|
<p>Minimum: <strong>1</strong></p>
|
||||||
<p>Maximum: <strong>36</strong></p>
|
<p>Maximum: <strong>36</strong></p>
|
||||||
@ -130,10 +127,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Value.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Value</p>
|
||||||
<ul><li><p>The value contains a maximum of 43 characters.</p>
|
<ul><li><p>It can contain a maximum of 43 characters.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li><li><p>The value can contain only digits, letters, hyphens (-), and underscores (_).</p>
|
</li><li><p>It can only contain digits, letters, hyphens (-), and underscores (_).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>0</strong></p>
|
<p>Minimum: <strong>0</strong></p>
|
||||||
<p>Maximum: <strong>43</strong></p>
|
<p>Maximum: <strong>43</strong></p>
|
||||||
@ -185,3 +182,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -55,9 +55,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Dump task operation. Currently, only the following operation is supported:</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Dump task operation. The value can only be <strong>start</strong>, which indicates starting a dump task.</p>
|
||||||
<ul><li><p>start: The dump task is started.</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>start</strong></p>
|
<ul><li><p><strong>start</strong></p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
@ -137,3 +135,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -55,9 +55,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Dump task operation. Currently, only the following operation is supported:</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Dump task operation. The value can only be <strong>stop</strong>, which indicates stopping a dump task.</p>
|
||||||
<ul><li><p>stop: The dump task is stopped.</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>stop</strong></p>
|
<ul><li><p><strong>stop</strong></p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
@ -137,3 +135,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
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
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/stream/{stream_id}/tags</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/stream/{stream_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -55,8 +55,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -102,10 +102,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Key.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Key</p>
|
||||||
<ul><li><p>This field cannot be left blank.</p>
|
<ul><li><p>It cannot be left blank.</p>
|
||||||
</li><li><p>The key value of a resource must be unique.</p>
|
</li><li><p>It must be unique for each resource.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>1</strong></p>
|
<p>Minimum: <strong>1</strong></p>
|
||||||
<p>Maximum: <strong>36</strong></p>
|
<p>Maximum: <strong>36</strong></p>
|
||||||
@ -117,10 +117,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Value.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Value</p>
|
||||||
<ul><li><p>The value contains a maximum of 43 characters.</p>
|
<ul><li><p>It can contain a maximum of 43 characters.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li><li><p>The value can contain only digits, letters, hyphens (-), and underscores (_).</p>
|
</li><li><p>It can only contain digits, letters, hyphens (-), and underscores (_).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>0</strong></p>
|
<p>Minimum: <strong>0</strong></p>
|
||||||
<p>Maximum: <strong>43</strong></p>
|
<p>Maximum: <strong>43</strong></p>
|
||||||
@ -168,3 +168,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/apps/{app_name}</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/apps/{app_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -54,8 +54,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -93,3 +93,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">App Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">App Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/streams/{stream_name}</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/streams/{stream_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -55,8 +55,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -94,3 +94,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Stream Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Stream Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/stream/{stream_id}/tags/{key}</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/stream/{stream_id}/tags/{key}</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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -63,8 +63,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -102,3 +102,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -63,8 +63,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -102,3 +102,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
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
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/stream/tags</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/stream/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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -45,8 +45,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -86,10 +86,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Key.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Key</p>
|
||||||
<ul><li><p>This field cannot be left blank.</p>
|
<ul><li><p>It cannot be left blank.</p>
|
||||||
</li><li><p>The key value of a resource must be unique.</p>
|
</li><li><p>It must be unique for each resource.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Maximum: <strong>36</strong></p>
|
<p>Maximum: <strong>36</strong></p>
|
||||||
</td>
|
</td>
|
||||||
@ -98,8 +98,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of strings</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of strings</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag value list.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>List of tag values</p>
|
||||||
<p>If values are null, it indicates any_value. The relationship between values is OR.</p>
|
<p>If <strong>values</strong> is an empty list, it indicates <strong>any_value</strong>. The values are in the OR relationship.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -145,3 +145,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/apps/{app_name}</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/apps/{app_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -54,8 +54,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -140,3 +140,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">App Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">App Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics</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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -40,18 +40,14 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Partition No. The value can be in either of the following formats:</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Partition ID The value can be in either of the following formats: - shardId-0000000000- 0 For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.</p>
|
||||||
<ul><li><p>shardId-0000000000</p>
|
|
||||||
</li><li><p>0</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -67,11 +63,11 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Partition monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.)</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Partition monitoring metric. (Either <strong>label</strong> or <strong>label_list</strong> must be specified. If they are both specified, <strong>label_list</strong> prevails.)</p>
|
||||||
<ul><li><p>total_put_bytes_per_partition: total input traffic of the partition (byte)</p>
|
<ul><li><p><strong>total_put_bytes_per_partition</strong>: total input traffic in a partition (byte)</p>
|
||||||
</li><li><p>total_get_bytes_per_partition: total output traffic of the partition (byte)</p>
|
</li><li><p><strong>total_get_bytes_per_partition</strong>: total output traffic in a partition (byte)</p>
|
||||||
</li><li><p>total_put_records_per_partition: total number of input records of the partition</p>
|
</li><li><p><strong>total_put_records_per_partition</strong>: total number of input records in a partition</p>
|
||||||
</li><li><p>total_get_records_per_partition: total number of output records of the partition</p>
|
</li><li><p><strong>total_get_records_per_partition</strong>: total number of output records in a partition</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>total_put_bytes_per_partition</strong></p>
|
<ul><li><p><strong>total_put_bytes_per_partition</strong></p>
|
||||||
@ -129,8 +125,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -239,3 +234,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Monitoring Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Monitoring Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/streams/{stream_name}/metrics</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/streams/{stream_name}/metrics</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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -38,7 +38,7 @@
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -54,17 +54,17 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Stream monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.)</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Stream monitoring metric (Either <strong>label</strong> or <strong>label_list</strong> must be specified. If they are both specified, <strong>label_list</strong> prevails.)</p>
|
||||||
<ul><li><p>total_put_bytes_per_stream: total input traffic (byte)</p>
|
<ul><li><p><strong>total_put_bytes_per_stream</strong>: total input traffic (byte)</p>
|
||||||
</li><li><p>total_get_bytes_per_stream: total output traffic (byte)</p>
|
</li><li><p><strong>total_get_bytes_per_stream</strong>: total output traffic (byte)</p>
|
||||||
</li><li><p>total_put_records_per_stream: total number of input records</p>
|
</li><li><p><strong>total_put_records_per_stream</strong>: total number of input records</p>
|
||||||
</li><li><p>total_get_records_per_stream: total number of output records</p>
|
</li><li><p><strong>total_get_records_per_stream</strong>: total number of output records</p>
|
||||||
</li><li><p>total_put_req_latency: average processing time of upload requests (millisecond)</p>
|
</li><li><p><strong>total_put_req_latency</strong>: average processing time of upload requests (millisecond)</p>
|
||||||
</li><li><p>total_get_req_latency: average processing time of download requests (millisecond)</p>
|
</li><li><p><strong>total_get_req_latency</strong>: average processing time of download requests (millisecond)</p>
|
||||||
</li><li><p>total_put_req_suc_per_stream: number of successful upload requests</p>
|
</li><li><p><strong>total_put_req_suc_per_stream</strong>: number of successful upload requests</p>
|
||||||
</li><li><p>total_get_req_suc_per_stream: number of successful download requests</p>
|
</li><li><p><strong>total_get_req_suc_per_stream</strong>: number of successful download requests</p>
|
||||||
</li><li><p>traffic_control_put: number of rejected upload requests due to flow control</p>
|
</li><li><p><strong>traffic_control_put</strong>: number of rejected upload requests due to flow control</p>
|
||||||
</li><li><p>traffic_control_get: number of rejected download requests due to flow control</p>
|
</li><li><p><strong>traffic_control_get</strong>: number of rejected download requests due to flow control</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>total_put_bytes_per_stream</strong></p>
|
<ul><li><p><strong>total_put_bytes_per_stream</strong></p>
|
||||||
@ -128,8 +128,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -245,3 +245,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Monitoring Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Monitoring Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/stream/{stream_id}/tags</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/stream/{stream_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -54,8 +54,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -95,10 +95,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Key.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Key</p>
|
||||||
<ul><li><p>This field cannot be left blank.</p>
|
<ul><li><p>It cannot be left blank.</p>
|
||||||
</li><li><p>The key value of a resource must be unique.</p>
|
</li><li><p>It must be unique for each resource.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>1</strong></p>
|
<p>Minimum: <strong>1</strong></p>
|
||||||
<p>Maximum: <strong>36</strong></p>
|
<p>Maximum: <strong>36</strong></p>
|
||||||
@ -108,10 +108,10 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Value.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Value</p>
|
||||||
<ul><li><p>The value contains a maximum of 43 characters.</p>
|
<ul><li><p>It can contain a maximum of 43 characters.</p>
|
||||||
</li><li><p>Character set: A-Z, a-z, 0-9, '. ', '-', '_', and Unicode characters (\u4E00-\u9FFF).</p>
|
</li><li><p>It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</p>
|
||||||
</li><li><p>The value can contain only digits, letters, hyphens (-), and underscores (_).</p>
|
</li><li><p>It can only contain digits, letters, hyphens (-), and underscores (_).</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Minimum: <strong>0</strong></p>
|
<p>Minimum: <strong>0</strong></p>
|
||||||
<p>Maximum: <strong>43</strong></p>
|
<p>Maximum: <strong>43</strong></p>
|
||||||
@ -160,3 +160,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tag Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/streams/{stream_name}</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>PUT /v2/{project_id}/streams/{stream_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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -55,8 +55,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -89,10 +89,11 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Integer</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>Integer</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Number of the target partitions.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Number of the target partitions</p>
|
||||||
<p>The value is an integer greater than 0.</p>
|
<p>The value is an integer greater than 0.</p>
|
||||||
<p>If the value is greater than the number of current partitions, scaling-up is required. If the value is less than the number of current partitions, scale-down is required.</p>
|
<p>If the value is greater than the number of current partitions, scaling-up is required. If the value is less than the number of current partitions, scale-down is required.</p>
|
||||||
<p>Note: A maximum of five scale-up/down operations can be performed for each stream within one hour. If a scale-up/down operation is successfully performed, you cannot perform one more scale-up/down operation within the next one hour.</p>
|
<p>Note:</p>
|
||||||
|
<p>Each stream can be scaled up and down for five times within one hour. After a stream is scaled up or down, it cannot be scaled up or down again in the next one hour.</p>
|
||||||
<p>Minimum: <strong>0</strong></p>
|
<p>Minimum: <strong>0</strong></p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@ -136,3 +137,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Stream Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Stream Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
<h1 class="topictitle1">Application Example</h1>
|
<h1 class="topictitle1">Application Example</h1>
|
||||||
<div id="body1493371267863"><div class="section" id="dis_02_0003__section4237340205619"><h4 class="sectiontitle">Scenarios</h4><p id="dis_02_0003__p622561555310">DIS provides efficient collection, transmission, and distribution capabilities for real-time data and provides a variety of APIs to help you quickly build real-time data applications.</p>
|
<div id="body1493371267863"><div class="section" id="dis_02_0003__section4237340205619"><h4 class="sectiontitle">Scenarios</h4><p id="dis_02_0003__p622561555310">DIS provides efficient collection, transmission, and distribution capabilities for real-time data and provides a variety of APIs to help you quickly build real-time data applications.</p>
|
||||||
<div class="p" id="dis_02_0003__p1669275285219">The following describes how to create a DIS stream by calling the <a href="dis_02_0016_01.html">Before You Start</a> API. For details, see <a href="dis_02_0516.html">Calling APIs</a>.<div class="note" id="dis_02_0003__note78851219195410"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dis_02_0003__p13885419115419">The token obtained on IAM is valid for only 24 hours. If you want to use one token for authentication, you can cache it to avoid frequent calling.</p>
|
<div class="p" id="dis_02_0003__p1669275285219">The following describes how to create a DIS stream by calling the <a href="dis_02_0511.html">Before You Start</a> API. For details, see <a href="dis_02_0516.html">Calling APIs</a>.<div class="note" id="dis_02_0003__note78851219195410"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dis_02_0003__p13885419115419">The token obtained on IAM is valid for only 24 hours. If you want to use one token for authentication, you can cache it to avoid frequent calling.</p>
|
||||||
</div></div>
|
</div></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -10,7 +10,7 @@
|
|||||||
<ul id="dis_02_0003__ul18839104814240"><li id="dis_02_0003__li48397486241">API for obtaining a token from IAM</li><li id="dis_02_0003__li1583954822419">API for creating a DIS stream</li></ul>
|
<ul id="dis_02_0003__ul18839104814240"><li id="dis_02_0003__li48397486241">API for obtaining a token from IAM</li><li id="dis_02_0003__li1583954822419">API for creating a DIS stream</li></ul>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="dis_02_0003__section153811408573"><h4 class="sectiontitle">Prerequisites</h4><p id="dis_02_0003__p169218462419">You have planned the region where DIS is located and determined the endpoint for calling an API based on the region.</p>
|
<div class="section" id="dis_02_0003__section153811408573"><h4 class="sectiontitle">Prerequisites</h4><p id="dis_02_0003__p169218462419">You have planned the region where DIS is located and determined the endpoint for calling an API based on the region.</p>
|
||||||
<p id="dis_02_0003__p15283119165716">An endpoint is the <strong id="dis_02_0003__en-us_topic_0000001082451448_b16300195371816">request address</strong> for calling an API. Endpoints vary depending on services and regions. You can obtain endpoints from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
<p id="dis_02_0003__p15283119165716">An endpoint is the <strong id="dis_02_0003__en-us_topic_0000001082451448_b16300195371816">request address</strong> for calling an API. Endpoints vary depending on services and regions. You can obtain endpoints of the service from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="dis_02_0003__section84735913247"><h4 class="sectiontitle">Creating a Stream</h4><p id="dis_02_0003__p14816162615113">The following is an example of creating a stream with the simplest configuration.</p>
|
<div class="section" id="dis_02_0003__section84735913247"><h4 class="sectiontitle">Creating a Stream</h4><p id="dis_02_0003__p14816162615113">The following is an example of creating a stream with the simplest configuration.</p>
|
||||||
<ol id="dis_02_0003__ol17437102653012"><li id="dis_02_0003__li672483213012">Obtain the token by following the instructions in <a href="dis_02_0517.html#dis_02_0517__en-us_topic_0183235768_en-us_topic_0181281305_dis_02_0517_en-us_topic_0121671869_section2417768214391">Token-based Authentication</a>.</li><li id="dis_02_0003__li105531825183417">Send <strong id="dis_02_0003__b19876121263010">POST https://Endpoint of DIS/v2/{project_id}/streams</strong>.</li><li id="dis_02_0003__li207811546133015">Add <strong id="dis_02_0003__b71221716183020">X-Auth-Token</strong> to the request header.</li><li id="dis_02_0003__li17564135310303">Specify the following parameters in the request body:<pre class="screen" id="dis_02_0003__screen336756143714">{
|
<ol id="dis_02_0003__ol17437102653012"><li id="dis_02_0003__li672483213012">Obtain the token by following the instructions in <a href="dis_02_0517.html#dis_02_0517__en-us_topic_0183235768_en-us_topic_0181281305_dis_02_0517_en-us_topic_0121671869_section2417768214391">Token-based Authentication</a>.</li><li id="dis_02_0003__li105531825183417">Send <strong id="dis_02_0003__b19876121263010">POST https://Endpoint of DIS/v2/{project_id}/streams</strong>.</li><li id="dis_02_0003__li207811546133015">Add <strong id="dis_02_0003__b71221716183020">X-Auth-Token</strong> to the request header.</li><li id="dis_02_0003__li17564135310303">Specify the following parameters in the request body:<pre class="screen" id="dis_02_0003__screen336756143714">{
|
||||||
@ -49,14 +49,11 @@
|
|||||||
"auto_scale_enabled": true,
|
"auto_scale_enabled": true,
|
||||||
"auto_scale_min_partition_count": 1,
|
"auto_scale_min_partition_count": 1,
|
||||||
"auto_scale_max_partition_count": 10
|
"auto_scale_max_partition_count": 10
|
||||||
<strong id="dis_02_0003__b12918159151914">"data_type": "JSON",</strong>
|
<strong id="dis_02_0003__b12918159151914">"data_type": "BLOG",</strong>
|
||||||
<strong id="dis_02_0003__b139205911915">"data_schema":</strong><strong id="dis_02_0003__b2248115719612"> </strong>
|
|
||||||
<strong id="dis_02_0003__b99212912195">"{\"type\":\"record\",\"name\":\"RecordName\",\"fields\":[{\"name\":\"key1\",\"type\":\"string\"},{\"name\":\"key2\",\"type\":\"string\"}]}"</strong>
|
|
||||||
}</pre>
|
}</pre>
|
||||||
<p id="dis_02_0003__p697374719418">In this example, a stream whose source data type is JSON and that contains the key1 and key2 attributes is created.</p>
|
|
||||||
<ul id="dis_02_0003__ul497324715413"><li id="dis_02_0003__li1990914574419"><strong id="dis_02_0003__b390013201464">data_type</strong> indicates the type of source data. The value <strong id="dis_02_0003__b1636151514720">JSON</strong> indicates that the data format in the partition is JSON.</li><li id="dis_02_0003__li139732471340"><strong id="dis_02_0003__b1367218201575">data_schema</strong> indicates the source data schema, which describes the source data structures in JSON and CSV formats using the Avro Schema syntax.</li></ul>
|
|
||||||
<p id="dis_02_0003__p126320020316">If the request is successful, 201 Created is returned.</p>
|
<p id="dis_02_0003__p126320020316">If the request is successful, 201 Created is returned.</p>
|
||||||
<p id="dis_02_0003__p206314015310">If the request fails, an error code and error information are returned. For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
<p id="dis_02_0003__p206314015310">If the request fails, an error code and error information are returned. For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
||||||
</li></ol>
|
</li></ol>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -20,3 +20,4 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/records</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/records</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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -28,7 +28,7 @@
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -45,7 +45,7 @@
|
|||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Data cursor, which needs to be obtained through the API for obtaining data cursors.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Data cursor, which needs to be obtained through the API for obtaining data cursors.</p>
|
||||||
<p>Value range: a string of 1 to 512 characters</p>
|
<p>Value: 1 to 512 characters</p>
|
||||||
<p>Note:</p>
|
<p>Note:</p>
|
||||||
<p>The validity period of a data cursor is 5 minutes.</p>
|
<p>The validity period of a data cursor is 5 minutes.</p>
|
||||||
</td>
|
</td>
|
||||||
@ -56,7 +56,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Maximum number of bytes that can be obtained for each request.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Maximum number of bytes that can be obtained for each request</p>
|
||||||
<p>Note:</p>
|
<p>Note:</p>
|
||||||
<p>If the value is less than the size of a single record in the partition, the record cannot be obtained.</p>
|
<p>If the value is less than the size of a single record in the partition, the record cannot be obtained.</p>
|
||||||
</td>
|
</td>
|
||||||
@ -82,8 +82,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -111,7 +111,7 @@
|
|||||||
</td>
|
</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.3.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Next iterator.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Next iterator</p>
|
||||||
<p>Note:</p>
|
<p>Note:</p>
|
||||||
<p>The validity period of a data cursor is 5 minutes.</p>
|
<p>The validity period of a data cursor is 5 minutes.</p>
|
||||||
</td>
|
</td>
|
||||||
@ -132,9 +132,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Partition key set when data is being uploaded.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Partition key set when data is being uploaded Note:If the <strong>partition_key</strong> parameter is passed when data is uploaded, this parameter will be returned when data is downloaded. If <strong>partition_id</strong> instead of <strong>partition_key</strong> is passed when data is uploaded, no <strong>partition_key</strong> is returned.</p>
|
||||||
<p>Note:</p>
|
|
||||||
<p>If the partition_key parameter is passed when data is uploaded, this parameter will be returned when data is downloaded. If partition_id instead of partition_key is passed when data is uploaded, no partition_key is returned.</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>sequence_number</p>
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>sequence_number</p>
|
||||||
@ -148,7 +146,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Downloaded data.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Downloaded data</p>
|
||||||
<p>The downloaded data is the serialized binary data (Base64-encoded character string).</p>
|
<p>The downloaded data is the serialized binary data (Base64-encoded character string).</p>
|
||||||
<p>For example, the data returned by the data download API is "ZGF0YQ==", which is "data" after Base64 decoding.</p>
|
<p>For example, the data returned by the data download API is "ZGF0YQ==", which is "data" after Base64 decoding.</p>
|
||||||
</td>
|
</td>
|
||||||
@ -164,8 +162,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Timestamp data type.</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Timestamp type</p>
|
||||||
<ul><li><p>CreateTime: creation time.</p>
|
<ul><li><p><strong>CreateTime</strong>: creation time</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
<p>Default: <strong>CreateTime</strong></p>
|
<p>Default: <strong>CreateTime</strong></p>
|
||||||
</td>
|
</td>
|
||||||
@ -214,3 +212,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Data Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Data Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/cursors</p>
|
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/cursors</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>
|
<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>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -28,7 +28,7 @@
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
|
||||||
</th>
|
</th>
|
||||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
|
||||||
</th>
|
</th>
|
||||||
@ -53,11 +53,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Partition ID of the stream. The value can be in either of the following formats:</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Partition ID of the stream The value can be in either of the following formats:- shardId-0000000000- 0For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.</p>
|
||||||
<ul><li><p>shardId-0000000000</p>
|
|
||||||
</li><li><p>0</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>cursor-type</p>
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>cursor-type</p>
|
||||||
@ -66,13 +62,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Cursor type.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Cursor type - <strong>AT_SEQUENCE_NUMBER</strong>: Data is read from the position denoted by a specific sequence number (that is defined by <strong>starting-sequence-number</strong>). This is the default cursor type. - <strong>AFTER_SEQUENCE_NUMBER</strong>: Data is read right after the position denoted by a specific sequence number (that is defined by <strong>starting-sequence-number</strong>). - <strong>TRIM_HORIZON</strong>: Data is read from the earliest valid record stored in the partition. For example, a tenant used a DIS stream to upload three pieces of data A1, A2, and A3. N days later, A1 has expired and A2 and A3 are still in the validity period. If the tenant specifies TRIM_HORIZON for downloading data, the system downloads data from A2. - <strong>LATEST</strong>: Data is read just after the most recent record in the partition. This setting ensures that you always read the most recent data in the partition. - <strong>AT_TIMESTAMP</strong>: Data is read from the position denoted by a specific timestamp.</p>
|
||||||
<ul><li><p>AT_SEQUENCE_NUMBER: Data is read from the position denoted by a specific sequence number (that is defined by starting-sequence-number). This is the default cursor type.</p>
|
|
||||||
</li><li><p>AFTER_SEQUENCE_NUMBER: Data is read right after the position denoted by a specific sequence number (that is defined by starting-sequence-number).</p>
|
|
||||||
</li><li><p>TRIM_HORIZON: Data is read from the earliest data record in the partition. For example, a tenant uses a DIS stream to upload three pieces of data A1, A2, and A3. N days later, A1 has expired and A2 and A3 are still in the validity period. In this case, if the tenant uses TRIM_HORIZON to download the data, the system downloads data from A2.</p>
|
|
||||||
</li><li><p>LATEST: Data is read from the latest record in the partition. This setting ensures that you always read the latest record in the partition.</p>
|
|
||||||
</li><li><p>AT_TIMESTAMP: Data is read from the position denoted by a specific timestamp.</p>
|
|
||||||
</li></ul>
|
|
||||||
<p>Enumeration values:</p>
|
<p>Enumeration values:</p>
|
||||||
<ul><li><p><strong>AT_SEQUENCE_NUMBER</strong></p>
|
<ul><li><p><strong>AT_SEQUENCE_NUMBER</strong></p>
|
||||||
</li><li><p><strong>AFTER_SEQUENCE_NUMBER</strong></p>
|
</li><li><p><strong>AFTER_SEQUENCE_NUMBER</strong></p>
|
||||||
@ -88,9 +78,7 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Serial number. A sequence number is a unique identifier for each record. DIS automatically allocates a sequence number when the data producer calls the PutRecords operation to add data to the DIS stream. SN of the same partition key usually changes with time. A longer interval between PutRecords requests results in a larger sequence number.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Sequence number. A sequence number is the unique identifier of each record. DIS automatically allocates a sequence number when the data producer calls the PutRecords operation to add data to the DIS stream. The sequence number of the same partition key usually changes with time. A longer interval between PutRecords requests results in a larger sequence number. The sequence number is closely related to cursor types <strong>AT_SEQUENCE_NUMBER</strong> and <strong>AFTER_SEQUENCE_NUMBER</strong>. The two parameters determine the location of the data to be accessed. Value range: 0 to 9223372036854775807</p>
|
||||||
<p>The sequence number is closely related to cursor types AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER. The two parameters determine the position of the data to be read.</p>
|
|
||||||
<p>Value range: 0 to 9,223,372,036,854,775,807</p>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>timestamp</p>
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>timestamp</p>
|
||||||
@ -99,11 +87,20 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Long</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Long</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Timestamp when the data record starts to be read, which is closely related to cursor type AT_TIMESTAMP. The two parameters determine the position of the data to be read.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Timestamp when the data record starts to be read, which is closely related to cursor type <strong>AT_TIMESTAMP</strong>. The two parameters determine the position of the data to be read.</p>
|
||||||
<p>Note:</p>
|
<p>Note:</p>
|
||||||
<p>The timestamp is accurate to milliseconds.</p>
|
<p>The timestamp is accurate to milliseconds.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>stream-id</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>Unique ID of the stream. This parameter is mandatory for obtaining the iterator of an authorized stream.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
@ -125,8 +122,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token.</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||||
<p>The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
@ -147,7 +144,8 @@
|
|||||||
</td>
|
</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.3.2.4.1.2 "><p>String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Data cursor. Value range: a string of 1 to 512 characters</p>
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Data cursor</p>
|
||||||
|
<p>Value: 1 to 512 characters</p>
|
||||||
<p>Note:</p>
|
<p>Note:</p>
|
||||||
<p>The validity period of a data cursor is 5 minutes.</p>
|
<p>The validity period of a data cursor is 5 minutes.</p>
|
||||||
<p>Minimum: <strong>1</strong></p>
|
<p>Minimum: <strong>1</strong></p>
|
||||||
@ -191,3 +189,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Data Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Data Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -332,3 +332,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dis_02_0500.html">Appendix</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dis_02_0500.html">Appendix</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -8,7 +8,21 @@
|
|||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody><tr id="dis_02_0023__row59961403367"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p17996440163613">2018-10-25</p>
|
<tbody><tr id="dis_02_0023__row1341147101111"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p12341547121117">2023-04-03</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p1039714616126">Modified the following sections:</p>
|
||||||
|
<p id="dis_02_0023__p1147181081210"><a href="dis_02_0016_01.html">Creating Streams</a></p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dis_02_0023__row19252112314407"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p625210231401">2022-09-30</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p9655194694019">Modified the following sections:</p>
|
||||||
|
<ul id="dis_02_0023__ul34812468516"><li id="dis_02_0023__li49101142183719"><a href="dis_02_0003.html">Application Example</a></li><li id="dis_02_0023__li14811646165113"><a href="topic_300000000.html">Stream Management</a></li><li id="dis_02_0023__li19481646195112"><a href="topic_300000001.html">App Management</a></li><li id="dis_02_0023__li12481144618517"><a href="topic_300000002.html">Checkpoint Management</a></li><li id="dis_02_0023__li84811946165111"><a href="en-us_topic_0000001079240698.html">Permissions Policies and Supported Actions</a></li></ul>
|
||||||
|
<p id="dis_02_0023__p363513125515">Offline the following sections:</p>
|
||||||
|
<ul id="dis_02_0023__ul11475162811524"><li id="dis_02_0023__li047582810524">Updating Stream Information</li><li id="dis_02_0023__li24751428125211">Adding Permission Policies</li><li id="dis_02_0023__li647542855218">Querying Permission Policies</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dis_02_0023__row59961403367"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p17996440163613">2018-10-25</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p19967404361">Accepted in OTC 3.2.</p>
|
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p19967404361">Accepted in OTC 3.2.</p>
|
||||||
</td>
|
</td>
|
||||||
@ -34,3 +48,4 @@
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -3,3 +3,4 @@
|
|||||||
<h1 class="topictitle1">API Overview</h1>
|
<h1 class="topictitle1">API Overview</h1>
|
||||||
<div id="body1526283540717"><p id="dis_02_0200__p11112662153235">DIS provides self-developed APIs that comply with RESTful API design specifications. You can use DIS functions listed in <a href="dis_02_0015.html">API Description</a> by calling these APIs.</p>
|
<div id="body1526283540717"><p id="dis_02_0200__p11112662153235">DIS provides self-developed APIs that comply with RESTful API design specifications. You can use DIS functions listed in <a href="dis_02_0015.html">API Description</a> by calling these APIs.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -160,8 +160,7 @@
|
|||||||
<p id="dis_02_0400__en-us_topic_0121682347_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="dis_02_0400__i333916502285">username</em>, <em id="dis_02_0400__i191111557142817">domainname</em>, <em id="dis_02_0400__i29811262919">********</em> (login password), and <em id="dis_02_0400__i167401714102917">xxxxxxxxxxxxxxxxxx</em> (project ID) with the actual values. To learn how to obtain a project ID, see <a href="dis_02_0501.html">Obtaining a Project ID</a>.</p>
|
<p id="dis_02_0400__en-us_topic_0121682347_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="dis_02_0400__i333916502285">username</em>, <em id="dis_02_0400__i191111557142817">domainname</em>, <em id="dis_02_0400__i29811262919">********</em> (login password), and <em id="dis_02_0400__i167401714102917">xxxxxxxxxxxxxxxxxx</em> (project ID) with the actual values. To learn how to obtain a project ID, see <a href="dis_02_0501.html">Obtaining a Project ID</a>.</p>
|
||||||
<div class="note" id="dis_02_0400__en-us_topic_0121682347_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dis_02_0400__en-us_topic_0121682347_p199011223194814">The <strong id="dis_02_0400__b468390193112">scope</strong> parameter specifies where a token takes effect. In the following example, the token takes effect only for the resources in a specified project. You can set <strong id="dis_02_0400__b960215521336">scope</strong> to a domain or a project under a domain. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a>.</p>
|
<div class="note" id="dis_02_0400__en-us_topic_0121682347_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dis_02_0400__en-us_topic_0121682347_p199011223194814">The <strong id="dis_02_0400__b468390193112">scope</strong> parameter specifies where a token takes effect. In the following example, the token takes effect only for the resources in a specified project. You can set <strong id="dis_02_0400__b960215521336">scope</strong> to a domain or a project under a domain. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtaining a user token</a>.</p>
|
||||||
</div></div>
|
</div></div>
|
||||||
<pre class="screen" id="dis_02_0400__en-us_topic_0121682347_screen6140617194816">
|
<pre class="screen" id="dis_02_0400__en-us_topic_0121682347_screen6140617194816">Content-Type: application/json
|
||||||
Content-Type: application/json
|
|
||||||
{
|
{
|
||||||
"auth": {
|
"auth": {
|
||||||
"identity": {
|
"identity": {
|
||||||
@ -193,3 +192,4 @@ Content-Type: application/json
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dis_02_0516.html">Calling APIs</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dis_02_0516.html">Calling APIs</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
File diff suppressed because it is too large
Load Diff
@ -80,7 +80,7 @@
|
|||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dis_02_0410__p1317801995814">String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dis_02_0410__p1317801995814">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dis_02_0410__p1179151985810">Dump destination. Possible values:</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dis_02_0410__p1179151985810">Dump destination. Possible values:</p>
|
||||||
<ul id="dis_02_0410__ul01794191583"><li id="dis_02_0410__li51791019165814">OBS: Data is dumped to OBS.</li><li id="dis_02_0410__li3179191916583">MRS: Data is dumped to MRS.</li><li id="dis_02_0410__li191799192584">DLI: Data is dumped to DLI.</li><li id="dis_02_0410__li1517991995810">CLOUDTABLE: Data is dumped to CloudTable.</li><li id="dis_02_0410__li1717911911582">DWS: Data is dumped to DWS.</li></ul>
|
<ul id="dis_02_0410__ul01794191583"><li id="dis_02_0410__li51791019165814">OBS: Data is dumped to OBS.</li></ul>
|
||||||
<p id="dis_02_0410__p1217941955819">Default: <strong id="dis_02_0410__b21791919175811">NOWHERE</strong></p>
|
<p id="dis_02_0410__p1217941955819">Default: <strong id="dis_02_0410__b21791919175811">NOWHERE</strong></p>
|
||||||
<p id="dis_02_0410__p9179161917587">Enumeration values:</p>
|
<p id="dis_02_0410__p9179161917587">Enumeration values:</p>
|
||||||
<ul id="dis_02_0410__ul181794199586"><li id="dis_02_0410__li101796198580"><strong id="dis_02_0410__b101791419155818">OBS</strong></li></ul>
|
<ul id="dis_02_0410__ul181794199586"><li id="dis_02_0410__li101796198580"><strong id="dis_02_0410__b101791419155818">OBS</strong></li></ul>
|
||||||
@ -205,12 +205,10 @@
|
|||||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dis_02_0410__p718710198583">String</p>
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dis_02_0410__p718710198583">String</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dis_02_0410__p1518713197589">Dump file format. Possible values:</p>
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dis_02_0410__p1518713197589">Dump file format. Possible values:</p>
|
||||||
<ul id="dis_02_0410__ul1718714199582"><li id="dis_02_0410__li11879196583">Text (default)</li><li id="dis_02_0410__li1018781975816">Parquet</li><li id="dis_02_0410__li141871719185811">CarbonData</li></ul>
|
<ul id="dis_02_0410__ul1718714199582"><li id="dis_02_0410__li11879196583">Text (default)</li></ul>
|
||||||
<p id="dis_02_0410__p10187519145819">Note:</p>
|
|
||||||
<p id="dis_02_0410__p101871119105810">You can select Parquet or CarbonData only when Source Data Type is set to JSON and Dump Destination is set to OBS.</p>
|
|
||||||
<p id="dis_02_0410__p018720192581">Default: <strong id="dis_02_0410__b51871619135813">text</strong></p>
|
<p id="dis_02_0410__p018720192581">Default: <strong id="dis_02_0410__b51871619135813">text</strong></p>
|
||||||
<p id="dis_02_0410__p81881919155812">Enumeration values:</p>
|
<p id="dis_02_0410__p81881919155812">Enumeration values:</p>
|
||||||
<ul id="dis_02_0410__ul11881419105817"><li id="dis_02_0410__li11188819185816"><strong id="dis_02_0410__b01881419165817">text</strong></li><li id="dis_02_0410__li1418871915583"><strong id="dis_02_0410__b14188121925811">parquet</strong></li><li id="dis_02_0410__li1218817193582"><strong id="dis_02_0410__b131881019115817">carbon</strong></li></ul>
|
<ul id="dis_02_0410__ul11881419105817"><li id="dis_02_0410__li11188819185816"><strong id="dis_02_0410__b01881419165817">text</strong></li></ul>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr id="dis_02_0410__row918021945815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dis_02_0410__p618818196583">processing_schema</p>
|
<tr id="dis_02_0410__row918021945815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dis_02_0410__p618818196583">processing_schema</p>
|
||||||
@ -302,7 +300,7 @@
|
|||||||
"deliver_time_interval" : 30
|
"deliver_time_interval" : 30
|
||||||
}
|
}
|
||||||
}</pre>
|
}</pre>
|
||||||
</li><li id="dis_02_0410__li1132801916583">Adding OBS Dump Tasks (The dump file format is Parquet.)<pre class="screen" id="dis_02_0410__screen16328319175811">POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
|
</li><li id="dis_02_0410__li1132801916583">Adding OBS Dump Tasks (The dump file format is Text.)<pre class="screen" id="dis_02_0410__screen16328319175811">POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
|
||||||
|
|
||||||
{
|
{
|
||||||
"destination_type" : "OBS",
|
"destination_type" : "OBS",
|
||||||
@ -310,7 +308,7 @@
|
|||||||
"task_name" : "newtask",
|
"task_name" : "newtask",
|
||||||
"consumer_strategy" : "LATEST",
|
"consumer_strategy" : "LATEST",
|
||||||
"agency_name" : "dis_admin_agency",
|
"agency_name" : "dis_admin_agency",
|
||||||
"destination_file_type" : "parquet",
|
"destination_file_type" : "text",
|
||||||
"obs_bucket_path" : "obsbucket",
|
"obs_bucket_path" : "obsbucket",
|
||||||
"file_prefix" : "",
|
"file_prefix" : "",
|
||||||
"partition_format" : "yyyy/MM/dd/HH/mm",
|
"partition_format" : "yyyy/MM/dd/HH/mm",
|
||||||
@ -346,3 +344,4 @@
|
|||||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Dump Task Management</a></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -12,3 +12,4 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<a name="dis_02_0501"></a><a name="dis_02_0501"></a>
|
<a name="dis_02_0501"></a><a name="dis_02_0501"></a>
|
||||||
|
|
||||||
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
||||||
<div id="body0000001238192617"><div class="section" id="dis_02_0501__en-us_topic_0191815273_section1691341861315"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="dis_02_0501__en-us_topic_0191815273_p996711364120">You can obtain a project ID by calling the API for <a href="https://docs.otc.t-systems.com/api/iam/en-us_topic_0057845625.html" target="_blank" rel="noopener noreferrer">Querying Project Information Based on the Specified Criteria</a>.</p>
|
<div id="body1558357284554"><div class="section" id="dis_02_0501__en-us_topic_0191815273_section1691341861315"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="dis_02_0501__en-us_topic_0191815273_p996711364120">You can obtain the project ID by calling the API<a href="https://docs.otc.t-systems.com/api/iam/en-us_topic_0057845625.html" target="_blank" rel="noopener noreferrer"> used to query project information</a>.</p>
|
||||||
<p id="dis_02_0501__en-us_topic_0191815273_p82371314564">The API for obtaining the project ID is <strong id="dis_02_0501__b12767162017585">GET https://{Endpoint}/v3/projects/</strong>, where <em id="dis_02_0501__i1976817207588">Endpoint</em> indicates the endpoint of IAM. You can obtain the endpoint from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. For details about API authentication, see <a href="dis_02_0517.html">Authentication</a>.</p>
|
<p id="dis_02_0501__en-us_topic_0191815273_p82371314564">The API used to obtain a project ID is GET <strong id="dis_02_0501__b1983601582711">https://{Endpoint}/v3/projects</strong>. <strong id="dis_02_0501__b68368152273">{Endpoint}</strong> is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. For details about API authentication, see <a href="dis_02_0517.html">Authentication</a>.</p>
|
||||||
<p id="dis_02_0501__en-us_topic_0191815273_p1461198134114">The following is an example response. The value of <strong id="dis_02_0501__b191120240588">id</strong> is the project ID. If multiple IDs are returned, obtain the desired project ID based on the actual region (name).</p>
|
<p id="dis_02_0501__en-us_topic_0191815273_p1461198134114">The following is an example response. The value of <strong id="dis_02_0501__b191120240588">id</strong> is the project ID. If multiple IDs are returned, obtain the desired project ID based on the actual region (name).</p>
|
||||||
<pre class="screen" id="dis_02_0501__en-us_topic_0191815273_screen676419149446">{
|
<pre class="screen" id="dis_02_0501__en-us_topic_0191815273_screen676419149446">{
|
||||||
"projects": [
|
"projects": [
|
||||||
@ -31,7 +31,7 @@
|
|||||||
<div class="section" id="dis_02_0501__en-us_topic_0191815273_section59621329127"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="dis_02_0501__en-us_topic_0191815273_p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
|
<div class="section" id="dis_02_0501__en-us_topic_0191815273_section59621329127"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="dis_02_0501__en-us_topic_0191815273_p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
|
||||||
<ol id="dis_02_0501__en-us_topic_0191815273_ol8715914194127"><li id="dis_02_0501__en-us_topic_0191815273_li50056756194127">Log in to the management console.</li><li id="dis_02_0501__en-us_topic_0191815273_li2804809915217">Click the username and select <strong id="dis_02_0501__b69745424588">My Credentials</strong> from the drop-down list.<p id="dis_02_0501__en-us_topic_0191815273_p136772519449">On the <strong id="dis_02_0501__b642094525813">My Credentials</strong> page, view project IDs in the project list.</p>
|
<ol id="dis_02_0501__en-us_topic_0191815273_ol8715914194127"><li id="dis_02_0501__en-us_topic_0191815273_li50056756194127">Log in to the management console.</li><li id="dis_02_0501__en-us_topic_0191815273_li2804809915217">Click the username and select <strong id="dis_02_0501__b69745424588">My Credentials</strong> from the drop-down list.<p id="dis_02_0501__en-us_topic_0191815273_p136772519449">On the <strong id="dis_02_0501__b642094525813">My Credentials</strong> page, view project IDs in the project list.</p>
|
||||||
</li></ol>
|
</li></ol>
|
||||||
<div class="fignone" id="dis_02_0501__en-us_topic_0191815273_fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="dis_02_0501__en-us_topic_0191815273_image538470016132" src="en-us_image_0000001238312593.jpg" title="Click to enlarge" class="imgResize"></span></div>
|
<div class="fignone" id="dis_02_0501__en-us_topic_0191815273_fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="dis_02_0501__en-us_topic_0191815273_image538470016132" src="en-us_image_0191919629.jpg"></span></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
@ -40,10 +40,3 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<script language="JavaScript">
|
|
||||||
<!--
|
|
||||||
image_size('.imgResize');
|
|
||||||
var msg_imageMax = "view original image";
|
|
||||||
var msg_imageClose = "close";
|
|
||||||
//--></script>
|
|
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