vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dis/api-ref/dis_02_0024.html
Xiong, Chen Xiao 83fa2f6615 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>
2023-06-27 15:26:05 +00:00

361 lines
27 KiB
HTML
Raw Blame History

<a name="dis_02_0024"></a><a name="dis_02_0024"></a>
<h1 class="topictitle1">Querying Streams</h1>
<div id="body1508105092919"><div class="section" id="dis_02_0024__section16508115082910"><h4 class="sectiontitle">Function</h4><p id="dis_02_0024__p1950815092913">This API is used to query all the streams created by the current tenant.</p>
<p id="dis_02_0024__p185081750172911">During query, you need to specify the stream from which the stream list is returned and the maximum number of streams returned in a single request.</p>
</div>
<div class="section" id="dis_02_0024__section95096502292"><h4 class="sectiontitle">URI</h4><p id="dis_02_0024__p14509115042910">GET /v2/{project_id}/streams</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__table1251011508295" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="dis_02_0024__row051055092919"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="dis_02_0024__p251075012912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="dis_02_0024__p1951175092917">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="dis_02_0024__p175111750102912">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="dis_02_0024__p15118509294">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row1051085013294"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="dis_02_0024__p95127503298">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="dis_02_0024__p185120504295">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="dis_02_0024__p185122050172911">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="dis_02_0024__p551365016294">Project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__table651420508292" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="dis_02_0024__row1651310507294"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="dis_02_0024__p14515165072911">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="dis_02_0024__p0515650162914">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="dis_02_0024__p15515165012296">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="dis_02_0024__p951517503294">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row551415508299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="dis_02_0024__p351615508295">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="dis_02_0024__p8516750132914">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="dis_02_0024__p1651665016298">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="dis_02_0024__p105161850142918">The maximum number of DIS streams to list in a single API call</p>
<p id="dis_02_0024__p3517105017294">Value range: 1 to 100</p>
<p id="dis_02_0024__p15171850172917">Default value: <strong id="dis_02_0024__b15517205019291">10</strong></p>
<p id="dis_02_0024__p951719504297">Minimum: <strong id="dis_02_0024__b4517050102911">1</strong></p>
<p id="dis_02_0024__p1051711505291">Maximum: <strong id="dis_02_0024__b1551855019298">100</strong></p>
<p id="dis_02_0024__p105181250202916">Default: <strong id="dis_02_0024__b5518145082918">10</strong></p>
</td>
</tr>
<tr id="dis_02_0024__row4514350192918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="dis_02_0024__p65184501296">start_stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="dis_02_0024__p55197503295">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="dis_02_0024__p1751965018294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="dis_02_0024__p35191850132917">Name of the DIS stream to start the stream list with. The returned stream list does not contain this DIS stream name. If pagination query is required, this parameter is not transferred when you query data on the first page. If the value of <strong id="dis_02_0024__b185201750122913">has_more_streams</strong> is <strong id="dis_02_0024__b3520115013295">true</strong>, the query is performed on the next page. The value of <strong id="dis_02_0024__b9520135012917">start_stream_name</strong> is the name of the last stream in the query result of the first page.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0024__section452011506295"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="dis_02_0024__row16520165022915"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="dis_02_0024__p1152216508296">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="dis_02_0024__p8522350172918">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="dis_02_0024__p12522195013291">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="dis_02_0024__p352395082919">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row1852175082911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dis_02_0024__p1523195012913">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dis_02_0024__p1252345032918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dis_02_0024__p20524175017294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dis_02_0024__p14524450102916">User token</p>
<p id="dis_02_0024__p1652495012912">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="dis_02_0024__b195241650102912">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0024__section6524250172916"><h4 class="sectiontitle">Response Parameters</h4><p id="dis_02_0024__p155251750102911"><strong id="dis_02_0024__b5525205012297">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__response_ListStreamsResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="dis_02_0024__row155251050202917"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="dis_02_0024__p195261650192913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="dis_02_0024__p19527175012299">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="dis_02_0024__p20527550142910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row12525250172912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0024__p20527850172912">total_number</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0024__p17527145011298">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0024__p1052825012919">Total number of all the DIS streams created by the current tenant.</p>
</td>
</tr>
<tr id="dis_02_0024__row652595016295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0024__p85281650172918">stream_names</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0024__p1952835013295">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0024__p6528250162914">List of the streams meeting the current requests.</p>
</td>
</tr>
<tr id="dis_02_0024__row1526135032910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0024__p152995012919">has_more_streams</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0024__p5529115082920">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0024__p953013507292">Whether there are more matching DIS streams</p>
<ul id="dis_02_0024__ul5530135012293"><li id="dis_02_0024__li6530165019299"><strong id="dis_02_0024__b10530950122919">true</strong>: yes</li><li id="dis_02_0024__li105301950162910"><strong id="dis_02_0024__b25301750102914">false</strong>: no</li></ul>
<p id="dis_02_0024__p175310508292">Default: <strong id="dis_02_0024__b25311250202914">false</strong></p>
</td>
</tr>
<tr id="dis_02_0024__row1452611506299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0024__p135311507293">stream_info_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0024__p195311350132913">Array of <a href="#dis_02_0024__response_StreamInfo">StreamInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0024__p11532350152917">Stream details.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0024__response_StreamInfo"></a><a name="response_StreamInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__response_StreamInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>StreamInfo</caption><thead align="left"><tr id="dis_02_0024__row5533135016291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="dis_02_0024__p653416506293">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="dis_02_0024__p5535150102912">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="dis_02_0024__p0535450192917">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row1533105016299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p4535185002915">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p1253615012294">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p17536450172919">Name of the stream.</p>
</td>
</tr>
<tr id="dis_02_0024__row10533950112919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p2537950162912">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p19538155015299">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p115381750202913">Time when the stream is created. The value is a 13-bit timestamp.</p>
</td>
</tr>
<tr id="dis_02_0024__row9533155022916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p6538550112918">retention_period</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p85381502291">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p553945015293">Period for storing data in units of hours.</p>
</td>
</tr>
<tr id="dis_02_0024__row1753325012913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p1653965082916">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p7539145042920">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p15540175010290">Current status of the stream</p>
<ul id="dis_02_0024__ul10540175042913"><li id="dis_02_0024__li554065014291"><strong id="dis_02_0024__b14540115017295">CREATING</strong>: creating</li><li id="dis_02_0024__li85403509294"><strong id="dis_02_0024__b155401150122918">RUNNING</strong>: running</li><li id="dis_02_0024__li1554018509295"><strong id="dis_02_0024__b15411950142918">TERMINATING</strong>: deleting</li><li id="dis_02_0024__li195411850102918"><strong id="dis_02_0024__b3541195019292">TERMINATED</strong>: deleted</li></ul>
<p id="dis_02_0024__p9541125082914">Enumeration values:</p>
<ul id="dis_02_0024__ul3541850182916"><li id="dis_02_0024__li55411650112915"><strong id="dis_02_0024__b10541195015291">CREATING</strong></li><li id="dis_02_0024__li17542115082911"><strong id="dis_02_0024__b55421750162918">RUNNING</strong></li><li id="dis_02_0024__li16542135062918"><strong id="dis_02_0024__b554295015297">TERMINATING</strong></li><li id="dis_02_0024__li14542145020290"><strong id="dis_02_0024__b95421950142910">FROZEN</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0024__row12533750102912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p8542155082913">stream_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p15543350102912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p135436508298">Stream type</p>
<ul id="dis_02_0024__ul1854395072912"><li id="dis_02_0024__li8543125042911"><strong id="dis_02_0024__b654365092916">COMMON</strong>: a common stream with a bandwidth of 1 MB/s</li><li id="dis_02_0024__li14543155042910"><strong id="dis_02_0024__b19544550152920">ADVANCED</strong>: an advanced stream with a bandwidth of 5 MB/s</li></ul>
<p id="dis_02_0024__p654475019294">Enumeration values:</p>
<ul id="dis_02_0024__ul1654445016298"><li id="dis_02_0024__li1954425012918"><strong id="dis_02_0024__b1754420509296">COMMON</strong></li><li id="dis_02_0024__li35441850122914"><strong id="dis_02_0024__b354535012293">ADVANCED</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0024__row2053317508295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p135454506291">data_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p1454565017299">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p13546950112917">Source data type</p>
<ul id="dis_02_0024__ul16546165011294"><li id="dis_02_0024__li05468502298"><strong id="dis_02_0024__b135461150112918">BLOB</strong>: a collection of binary data stored as a single entity in a database management system</li></ul>
<p id="dis_02_0024__p25470504290">Default value: <strong id="dis_02_0024__b115475501292">BLOB</strong></p>
<p id="dis_02_0024__p7547125022914">Enumeration values:</p>
<ul id="dis_02_0024__ul054765010296"><li id="dis_02_0024__li18547165018298"><strong id="dis_02_0024__b2547165012293">BLOB</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0024__row9533155013292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p1854816504299">partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p1254835062914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p155489509293">Number of partitions</p>
<p id="dis_02_0024__p15548175010299">Partitions are the base throughput unit of the DIS stream.</p>
</td>
</tr>
<tr id="dis_02_0024__row2533155013296"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p17549125062917">auto_scale_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p1954925012297">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p20549185014297">Whether to enable auto scaling</p>
<ul id="dis_02_0024__ul7549135015291"><li id="dis_02_0024__li16551950172917"><strong id="dis_02_0024__b175521550172917">true</strong>: Auto scaling is enabled.</li><li id="dis_02_0024__li3552145020290"><strong id="dis_02_0024__b1755275032911">false</strong>: Auto scaling is disabled.</li></ul>
<p id="dis_02_0024__p955275014292">By default, this function is disabled.</p>
<p id="dis_02_0024__p1655215072917">Default: <strong id="dis_02_0024__b8553850162918">false</strong></p>
</td>
</tr>
<tr id="dis_02_0024__row65341650202917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p13553125022910">auto_scale_min_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p1255385082912">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p19553125019290">Minimum number of partitions for automatic scale-down when auto scaling is enabled.</p>
<p id="dis_02_0024__p85542050182919">Minimum: <strong id="dis_02_0024__b6554350152911">1</strong></p>
</td>
</tr>
<tr id="dis_02_0024__row18534185002919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p1355410509299">auto_scale_max_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p10554175042913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p65544501291">Maximum number of partitions for automatic scale-up when auto scaling is enabled.</p>
</td>
</tr>
<tr id="dis_02_0024__row5534125015295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p11555145062914">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p1155514505293">Array of <a href="#dis_02_0024__response_Tag">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p4555550102910">List of stream tags.</p>
</td>
</tr>
<tr id="dis_02_0024__row115345506295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0024__p85551050132915">sys_tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0024__p95561050152914">Array of <a href="#dis_02_0024__response_SysTag">SysTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0024__p145562501293">Stream enterprise projects.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0024__response_Tag"></a><a name="response_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__response_Tag" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Tag</caption><thead align="left"><tr id="dis_02_0024__row0557195092913"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="dis_02_0024__p4557125042920">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="dis_02_0024__p1555835018294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="dis_02_0024__p1155815016292">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row13557850182918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0024__p455875010295">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0024__p25594507297">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0024__p85591550132910">Key</p>
<ul id="dis_02_0024__ul18559175015290"><li id="dis_02_0024__li12559165012299">It cannot be left blank.</li><li id="dis_02_0024__li10559185018293">It must be unique for each resource.</li><li id="dis_02_0024__li7560135002919">It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</li></ul>
<p id="dis_02_0024__p10560150132919">Minimum: <strong id="dis_02_0024__b856055018293">1</strong></p>
<p id="dis_02_0024__p1356095092912">Maximum: <strong id="dis_02_0024__b4560125019292">36</strong></p>
</td>
</tr>
<tr id="dis_02_0024__row8557450202914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0024__p1456035012919">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0024__p6561165017296">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0024__p456115011297">Value</p>
<ul id="dis_02_0024__ul1056135042912"><li id="dis_02_0024__li18561850152911">It can contain a maximum of 43 characters.</li><li id="dis_02_0024__li13561250142920">It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</li><li id="dis_02_0024__li15621650122918">It can only contain digits, letters, hyphens (-), and underscores (_).</li></ul>
<p id="dis_02_0024__p15627507298">Minimum: <strong id="dis_02_0024__b356214508296">0</strong></p>
<p id="dis_02_0024__p356214506293">Maximum: <strong id="dis_02_0024__b156275019294">43</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0024__response_SysTag"></a><a name="response_SysTag"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__response_SysTag" frame="border" border="1" rules="all"><caption><b>Table 7 </b>SysTag</caption><thead align="left"><tr id="dis_02_0024__row15621850152917"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="dis_02_0024__p95651150122913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="dis_02_0024__p105651750202912">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="dis_02_0024__p1956610502291">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row1563650192918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dis_02_0024__p1556619501296">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dis_02_0024__p556765052920">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dis_02_0024__p1756735012291">Key</p>
<ul id="dis_02_0024__ul9567205032911"><li id="dis_02_0024__li656713501297">It cannot be left blank.</li><li id="dis_02_0024__li12567550192916">Its value must be <strong id="dis_02_0024__b656715507298">_sys_enterprise_project_id</strong>.</li></ul>
<p id="dis_02_0024__p2568550162918">Enumeration values:</p>
<ul id="dis_02_0024__ul155686504297"><li id="dis_02_0024__li15568105016292"><strong id="dis_02_0024__b105681509294">_sys_enterprise_project_id</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0024__row85649508295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dis_02_0024__p1656815072914">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dis_02_0024__p15681509298">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dis_02_0024__p7569115016295">Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.</p>
<ul id="dis_02_0024__ul19569145019297"><li id="dis_02_0024__li956945012914">It is a 36-digit UUID.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0024__section195691750142911"><h4 class="sectiontitle">Example Requests</h4><p id="dis_02_0024__p0570650112918">Querying Streams</p>
<pre class="screen" id="dis_02_0024__screen8570105017293">GET https://{Endpoint}/v2/{project_id}/streams</pre>
</div>
<div class="section" id="dis_02_0024__section65701850162911"><h4 class="sectiontitle">Example Responses</h4><p id="dis_02_0024__p14571050142910"><strong id="dis_02_0024__b25716504293">Status code: 200</strong></p>
<p id="dis_02_0024__p957135013292">Normal response.</p>
<pre class="screen" id="dis_02_0024__screen95721503291">{
"total_number" : 1,
"stream_names" : [ "newstream" ],
"stream_info_list" : [ {
"stream_id" : "8QM3Nt9YTLOwtUVYJhO",
"stream_name" : "newstream",
"create_time" : 1593569685875,
"retention_period" : 24,
"status" : "RUNNING",
"stream_type" : "COMMON",
"data_type" : "BLOB",
"partition_count" : 1,
"tags" : [ ],
"auto_scale_enabled" : false,
"auto_scale_min_partition_count" : 0,
"auto_scale_max_partition_count" : 0
} ],
"has_more_streams" : false
}</pre>
</div>
<div class="section" id="dis_02_0024__section187101350182913"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0024__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="dis_02_0024__row165762050132913"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="dis_02_0024__p13710650172911">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="dis_02_0024__p57101507298">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0024__row557618508296"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="dis_02_0024__p17101650122917">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="dis_02_0024__p571065010293">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0024__section6710550132910"><h4 class="sectiontitle">Error Codes</h4><p id="dis_02_0024__p271095017297">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>
View Git Blame Copy Permalink