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

Reimplementation of docs/doc-exports#263

Browse Source 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
This commit is contained in:
gtema 2022-11-11 12:03:08 +00:00 committed by zuul
parent 7d48c93785
commit 6bc123a554
104 changed files with 13180 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

642
docs/dis/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

187
docs/dis/api-ref/BatchCreateTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

187
docs/dis/api-ref/BatchDeleteTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

139
docs/dis/api-ref/BatchStartTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

139
docs/dis/api-ref/BatchStopTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

578
docs/dis/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

116
docs/dis/api-ref/CreateApp.html Normal file
View File

File diff suppressed because it is too large Load Diff

685
docs/dis/api-ref/CreateCloudTableTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

246
docs/dis/api-ref/CreateDliTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

445
docs/dis/api-ref/CreateDwsTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

287
docs/dis/api-ref/CreateMrsTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

177
docs/dis/api-ref/CreatePolicies.html Normal file
View File

File diff suppressed because it is too large Load Diff

170
docs/dis/api-ref/CreateTag.html Normal file
View File

File diff suppressed because it is too large Load Diff

95
docs/dis/api-ref/DeleteApp.html Normal file
View File

@ -0,0 +1,95 @@
<a name="DeleteApp"></a><a name="DeleteApp"></a>
<h1 class="topictitle1">Deleting Apps</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete apps.</p>
</div>
<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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>app_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Name of the app to be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteApp__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<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>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting Apps</p>
<pre class="screen">DELETE https://{Endpoint}/v2/{project_id}/apps/{app_name}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteApp__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">App Management</a></div>
</div>
</div>

145
docs/dis/api-ref/DeleteCheckpoint.html Normal file
View File

File diff suppressed because it is too large Load Diff

96
docs/dis/api-ref/DeleteStream.html Normal file
View File

@ -0,0 +1,96 @@
<a name="DeleteStream"></a><a name="DeleteStream"></a>
<h1 class="topictitle1">Deleting Specified Streams</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete specified streams.</p>
</div>
<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>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Name of the stream to be deleted.</p>
<p>Maximum: <strong>60</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteStream__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<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>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting Specified Streams</p>
<pre class="screen">DELETE https://{Endpoint}/v2/{project_id}/streams/{stream_name}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteStream__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Stream Management</a></div>
</div>
</div>

104
docs/dis/api-ref/DeleteTag.html Normal file
View File

File diff suppressed because it is too large Load Diff

104
docs/dis/api-ref/DeleteTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

619
docs/dis/api-ref/ErrorCode.html Normal file
View File

File diff suppressed because it is too large Load Diff

231
docs/dis/api-ref/ListApp.html Normal file
View File

File diff suppressed because it is too large Load Diff

185
docs/dis/api-ref/ListPolicies.html Normal file
View File

File diff suppressed because it is too large Load Diff

374
docs/dis/api-ref/ListResourcesByTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

147
docs/dis/api-ref/ListTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

216
docs/dis/api-ref/ListTransferTasks.html Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/dis/api-ref/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

142
docs/dis/api-ref/ShowApp.html Normal file
View File

File diff suppressed because it is too large Load Diff

176
docs/dis/api-ref/ShowCheckpoint.html Normal file
View File

File diff suppressed because it is too large Load Diff

206
docs/dis/api-ref/ShowConsumerState.html Normal file
View File

File diff suppressed because it is too large Load Diff

241
docs/dis/api-ref/ShowPartitionMetrics.html Normal file
View File

File diff suppressed because it is too large Load Diff

247
docs/dis/api-ref/ShowStreamMetrics.html Normal file
View File

File diff suppressed because it is too large Load Diff

162
docs/dis/api-ref/ShowStreamTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

1278
docs/dis/api-ref/ShowTransferTask.html Normal file
View File

File diff suppressed because it is too large Load Diff

138
docs/dis/api-ref/UpdatePartitionCount.html Normal file
View File

File diff suppressed because it is too large Load Diff

183
docs/dis/api-ref/UpdateStream.html Normal file
View File

File diff suppressed because it is too large Load Diff

62
docs/dis/api-ref/dis_02_0003.html Normal file
View File

@ -0,0 +1,62 @@
<a name="dis_02_0003"></a><a name="dis_02_0003"></a>
<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 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></div>
</div>
</div>
<div class="section" id="dis_02_0003__section101152312311"><h4 class="sectiontitle">Involved APIs</h4><p id="dis_02_0003__p208391848152419">If you use a token for authentication, you must obtain the token and add <strong id="dis_02_0003__b93839580536">X-Auth-Token</strong> to the request header of the API request.</p>
<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 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>
</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>
<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">{
"stream_name": "dis-DLpR",
"partition_count": 1,
"stream_type": "COMMON",
"data_duration": 24
}</pre>
<ul id="dis_02_0003__ul19791196017"><li id="dis_02_0003__li15791191700"><strong id="dis_02_0003__b02057187211">stream_name</strong> indicates the stream name, which can be customized, for example, <strong id="dis_02_0003__b11703171152111">newstream</strong>.</li><li id="dis_02_0003__li2792917014"><strong id="dis_02_0003__b4622123172119">partition_count</strong> indicates the number of partitions. A partition is the base throughput unit of a DIS stream. You can specify the number of partitions based on your service throughput requirements.</li><li id="dis_02_0003__li18791894017"><strong id="dis_02_0003__b19806716343">stream_type</strong> indicates the stream type. <strong id="dis_02_0003__b1357571813415">COMMON</strong> indicates a common partition. A single partition supports a maximum of 1 MB/s for data writing and a maximum of 2 MB/s for data reading.</li><li id="dis_02_0003__li16792096014"><strong id="dis_02_0003__b2821543194010">data_duration</strong> indicates the lifecycle of a stream, that is, the duration for storing data in the stream partition.</li></ul>
<p id="dis_02_0003__p143117175381">If the request is successful, 201 Created is returned.</p>
<p id="dis_02_0003__p199019514316">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>
</div>
<div class="section" id="dis_02_0003__section45378497019"><h4 class="sectiontitle">Creating a Stream That Supports Auto Scaling</h4><p id="dis_02_0003__p155381430213">You can also create a stream that supports auto scaling. The number of partitions can be automatically increased or decreased based on the stream traffic. The following is an example configuration:</p>
<ol id="dis_02_0003__ol15537124912020"><li id="dis_02_0003__li135377491300">Obtain the token by following the instructions provided 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__li85372498017">Send <strong id="dis_02_0003__b1221952918">POST https://Endpoint of DIS/v2/{project_id}/streams</strong>.</li><li id="dis_02_0003__li3537114920016">Add <strong id="dis_02_0003__b86753726">X-Auth-Token</strong> to the request header.</li><li id="dis_02_0003__li153718493010">Specify the following parameters in the request body:<pre class="screen" id="dis_02_0003__screen553720495019">{
"stream_name": "dis-DLpR",
"partition_count": 1,
"stream_type": "COMMON",
"data_duration": 24
<strong id="dis_02_0003__b17295172481811">"auto_scale_enabled": true,</strong>
<strong id="dis_02_0003__b1029752431814">"auto_scale_min_partition_count": 2,</strong>
<strong id="dis_02_0003__b17298724141810">"auto_scale_max_partition_count": 10</strong>
}</pre>
<p id="dis_02_0003__p13057251210">In this example, a stream that supports auto scaling is created. The number of partitions to scale ranges from 2 to 10. If the stream has 10 partitions, auto scaling-out will not be triggered.</p>
<ul id="dis_02_0003__ul1830511253216"><li id="dis_02_0003__li7305112510216"><strong id="dis_02_0003__b1222391055817">auto_scale_enabled</strong> specifies whether to enable auto scaling. The value <strong id="dis_02_0003__b12448131920582">true</strong> indicates that auto scaling is enabled.</li><li id="dis_02_0003__li029103810214"><strong id="dis_02_0003__b15929339582">auto_scale_min_partition_count</strong> indicates the minimum number of partitions allowed when auto scale-in is enabled. In this example, as there are two partitions, automatic scale-in will not be triggered.</li><li id="dis_02_0003__li2305825722"><strong id="dis_02_0003__b176151291411">auto_scale_max_partition_count</strong> indicates the maximum number of partitions allowed when auto scale-out is enabled. In this example, as there are 10 partitions, automatic scale-out will not be triggered.</li></ul>
<p id="dis_02_0003__p1553810492011">If the request is successful, 201 Created is returned.</p>
<p id="dis_02_0003__p25386491108">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>
</div>
<div class="section" id="dis_02_0003__section126311019314"><h4 class="sectiontitle">Creating a Stream with Data Schemas</h4><p id="dis_02_0003__p1763201934">You can also configure a schema for the stream. When using DIS to dump data to other services, you can map data based on the schema configured for the stream. The following is an example configuration:</p>
<ol id="dis_02_0003__ol463809313"><li id="dis_02_0003__li163509316">Obtain the token by following the instructions provided 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__li1631011319">Send <strong id="dis_02_0003__b1158478934">POST https://Endpoint of DIS/v2/{project_id}/streams</strong>.</li><li id="dis_02_0003__li166314014315">Add <strong id="dis_02_0003__b378052235">X-Auth-Token</strong> to the request header.</li><li id="dis_02_0003__li96313017318">Specify the following parameters in the request body:<pre class="screen" id="dis_02_0003__screen663501318">{
"stream_name": "dis-DLpR",
"partition_count": 1,
"stream_type": "COMMON",
"data_duration": 24
"auto_scale_enabled": true,
"auto_scale_min_partition_count": 1,
"auto_scale_max_partition_count": 10
<strong id="dis_02_0003__b12918159151914">"data_type": "JSON",</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>
<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__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>
</div>
</div>

22
docs/dis/api-ref/dis_02_0015.html Normal file
View File

@ -0,0 +1,22 @@
<a name="dis_02_0015"></a><a name="dis_02_0015"></a>
<h1 class="topictitle1">API Description</h1>
<div id="body1493371267863"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="topic_300000000.html">Stream Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000001.html">App Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000002.html">Checkpoint Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000003.html">Data Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000004.html">Dump Task Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000005.html">Monitoring Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000006.html">Tag Management</a></strong><br>
</li>
</ul>
</div>

370
docs/dis/api-ref/dis_02_0016_01.html Normal file
View File

File diff suppressed because it is too large Load Diff

259
docs/dis/api-ref/dis_02_0018.html Normal file
View File

File diff suppressed because it is too large Load Diff

216
docs/dis/api-ref/dis_02_0019.html Normal file
View File

File diff suppressed because it is too large Load Diff

193
docs/dis/api-ref/dis_02_0020.html Normal file
View File

File diff suppressed because it is too large Load Diff

334
docs/dis/api-ref/dis_02_0022.html Normal file
View File

File diff suppressed because it is too large Load Diff

36
docs/dis/api-ref/dis_02_0023.html Normal file
View File

@ -0,0 +1,36 @@
<a name="dis_02_0023"></a><a name="dis_02_0023"></a>
<h1 class="topictitle1">Change History</h1>
<div id="body1495510476861">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0023__table15766105510343" frame="border" border="1" rules="all"><thead align="left"><tr id="dis_02_0023__row17666554345"><th align="left" class="cellrowborder" valign="top" width="36.480000000000004%" id="mcps1.3.1.1.3.1.1"><p id="dis_02_0023__p1976615513414"><strong id="dis_02_0023__b166486484562">Released On</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.519999999999996%" id="mcps1.3.1.1.3.1.2"><p id="dis_02_0023__p57661555183418"><strong id="dis_02_0023__b250495418563">Description</strong></p>
</th>
</tr>
</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>
</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>
</tr>
<tr id="dis_02_0023__row8633162516328"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p463372517325">2018-09-29</p>
</td>
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p3633142515323">Modified the following contents:</p>
<p id="dis_02_0023__p18336840153217">Added tag management APIs</p>
</td>
</tr>
<tr id="dis_02_0023__row7782855173412"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p68121802354">2018-09-26</p>
</td>
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p481280203518">Modified the following contents:</p>
<p id="dis_02_0023__p17850184015368">A status code was added in <a href="dis_02_0022.html">Status Codes</a>.</p>
</td>
</tr>
<tr id="dis_02_0023__row1979711553342"><td class="cellrowborder" valign="top" width="36.480000000000004%" headers="mcps1.3.1.1.3.1.1 "><p id="dis_02_0023__p1779735518345">2018-03-16</p>
</td>
<td class="cellrowborder" valign="top" width="63.519999999999996%" headers="mcps1.3.1.1.3.1.2 "><p id="dis_02_0023__p37974554348">This issue is the first official release.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

390
docs/dis/api-ref/dis_02_0024.html Normal file
View File

File diff suppressed because it is too large Load Diff

565
docs/dis/api-ref/dis_02_0025.html Normal file
View File

File diff suppressed because it is too large Load Diff

5
docs/dis/api-ref/dis_02_0200.html Normal file
View File

@ -0,0 +1,5 @@
<a name="dis_02_0200"></a><a name="dis_02_0200"></a>
<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>

195
docs/dis/api-ref/dis_02_0400.html Normal file
View File

File diff suppressed because it is too large Load Diff

173
docs/dis/api-ref/dis_02_0403.html Normal file
View File

File diff suppressed because it is too large Load Diff

348
docs/dis/api-ref/dis_02_0410.html Normal file
View File

File diff suppressed because it is too large Load Diff

14
docs/dis/api-ref/dis_02_0500.html Normal file
View File

@ -0,0 +1,14 @@
<a name="dis_02_0500"></a><a name="dis_02_0500"></a>
<h1 class="topictitle1">Appendix</h1>
<div id="body1514363268625"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ErrorCode.html">Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dis_02_0022.html">Status Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dis_02_0501.html">Obtaining a Project ID</a></strong><br>
</li>
</ul>
</div>

49
docs/dis/api-ref/dis_02_0501.html Normal file
View File

@ -0,0 +1,49 @@
<a name="dis_02_0501"></a><a name="dis_02_0501"></a>
<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>
<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_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">{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14e684b",
"name": "region_name",
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
},
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}</pre>
</div>
<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>
</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>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dis_02_0500.html">Appendix</a></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