lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dis/api-ref/dis_02_0025.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

497 lines
37 KiB
HTML
Raw Blame History

<a name="dis_02_0025"></a><a name="dis_02_0025"></a>
<h1 class="topictitle1">Querying Stream Details</h1>
<div id="body830185117299"><div class="section" id="dis_02_0025__section130105116299"><h4 class="sectiontitle">Function</h4><p id="dis_02_0025__p031165182910">This API is used to query details about a specified stream.</p>
</div>
<div class="section" id="dis_02_0025__section143295114292"><h4 class="sectiontitle">URI</h4><p id="dis_02_0025__p17321651192910">GET /v2/{project_id}/streams/{stream_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__table73415517299" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="dis_02_0025__row15331851122916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="dis_02_0025__p20349515293">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_0025__p5341751192916">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_0025__p43515119290">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_0025__p1335195152912">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row8334513291"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="dis_02_0025__p1351851122915">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="dis_02_0025__p93675142912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="dis_02_0025__p1736175172914">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="dis_02_0025__p93715111298">Project ID.</p>
</td>
</tr>
<tr id="dis_02_0025__row1331651132918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="dis_02_0025__p63765122915">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="dis_02_0025__p173710515291">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="dis_02_0025__p1638155142913">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="dis_02_0025__p63815517298">Stream to be queried.</p>
<p id="dis_02_0025__p143865142914">Maximum: <strong id="dis_02_0025__b83918518298">60</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__table1240251152915" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="dis_02_0025__row10394510299"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="dis_02_0025__p1740175110293">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_0025__p18416516290">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_0025__p1841951152912">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_0025__p842145142917">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row039105118290"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="dis_02_0025__p1742125115298">start_partitionId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="dis_02_0025__p154225102916">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="dis_02_0025__p643135117296">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="dis_02_0025__p134335142919">Name of the partition to start the partition list with. The returned partition list does not contain this partition.</p>
</td>
</tr>
<tr id="dis_02_0025__row1397510293"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="dis_02_0025__p174465112290">limit_partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="dis_02_0025__p1944155120294">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="dis_02_0025__p2441151102913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="dis_02_0025__p34555115291">Maximum number of partitions to list in a single API call</p>
<p id="dis_02_0025__p15459512299">Value range: 1 to 1000</p>
<p id="dis_02_0025__p5451651122912">Default value: <strong id="dis_02_0025__b154510512299">100</strong></p>
<p id="dis_02_0025__p84617511297">Minimum: <strong id="dis_02_0025__b134695112914">1</strong></p>
<p id="dis_02_0025__p10464516297">Maximum: <strong id="dis_02_0025__b10468515293">1000</strong></p>
<p id="dis_02_0025__p54675112290">Default: <strong id="dis_02_0025__b18461151132918">100</strong></p>
</td>
</tr>
<tr id="dis_02_0025__row939115111296"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="dis_02_0025__p1847165110295">stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="dis_02_0025__p1547185117297">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="dis_02_0025__p84895122915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="dis_02_0025__p248105113293">Stream ID. This parameter is mandatory for querying details of an authorized stream.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0025__section15488518291"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="dis_02_0025__row1450651172912"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="dis_02_0025__p251135113291">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_0025__p051175112298">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_0025__p451135112917">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_0025__p115255192911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row850195182914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dis_02_0025__p115213513295">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_0025__p16521751182910">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dis_02_0025__p953195112910">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dis_02_0025__p45316510296">User token</p>
<p id="dis_02_0025__p154851142917">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="dis_02_0025__b1754551122918">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_0025__section75435111293"><h4 class="sectiontitle">Response Parameters</h4><p id="dis_02_0025__p15541451172918"><strong id="dis_02_0025__b1854105142910">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__response_DescribeStreamResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="dis_02_0025__row55512514299"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="dis_02_0025__p25995116291">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_0025__p759251172918">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_0025__p11599519291">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row1856115152919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p260551172917">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p136085114297">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p4600517295">Name of the stream.</p>
</td>
</tr>
<tr id="dis_02_0025__row75665114297"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p561185172914">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p86117518292">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p26155132917">Time when a stream is created. The value is a 13-bit timestamp.</p>
</td>
</tr>
<tr id="dis_02_0025__row95695132917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p1362551172919">last_modified_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p126235114299">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p1363145119291">Time when a stream is the most recently modified. The value is a 13-bit timestamp.</p>
</td>
</tr>
<tr id="dis_02_0025__row8562517291"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p196375117294">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p2632516292">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p16485118294">Current status of the stream</p>
<ul id="dis_02_0025__ul6641851142916"><li id="dis_02_0025__li166555114298"><strong id="dis_02_0025__b1865145192918">CREATING</strong>: creating</li><li id="dis_02_0025__li96555111293"><strong id="dis_02_0025__b465145102917">RUNNING</strong>: running</li><li id="dis_02_0025__li1965151142913"><strong id="dis_02_0025__b2066151162919">TERMINATING</strong>: deleting</li><li id="dis_02_0025__li66685110298"><strong id="dis_02_0025__b6661451102918">TERMINATED</strong>: deleted</li></ul>
<p id="dis_02_0025__p96675114297">Enumeration values:</p>
<ul id="dis_02_0025__ul96665112918"><li id="dis_02_0025__li767115112911"><strong id="dis_02_0025__b12672051152910">CREATING</strong></li><li id="dis_02_0025__li11671551112919"><strong id="dis_02_0025__b16671751162910">RUNNING</strong></li><li id="dis_02_0025__li1667115117298"><strong id="dis_02_0025__b7681251192910">TERMINATING</strong></li><li id="dis_02_0025__li96835162916"><strong id="dis_02_0025__b168125192917">FROZEN</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0025__row1156751172915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p16885152910">stream_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p16812515292">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p116975162917">Stream type</p>
<ul id="dis_02_0025__ul1769125102916"><li id="dis_02_0025__li6691751162917"><strong id="dis_02_0025__b37011510293">COMMON</strong>: a common stream with a bandwidth of 1 MB/s</li><li id="dis_02_0025__li167018518295"><strong id="dis_02_0025__b137035182914">ADVANCED</strong>: an advanced stream with a bandwidth of 5 MB/s</li></ul>
<p id="dis_02_0025__p14701051172920">Enumeration values:</p>
<ul id="dis_02_0025__ul171105119296"><li id="dis_02_0025__li157145192919"><strong id="dis_02_0025__b127195111298">COMMON</strong></li><li id="dis_02_0025__li571125132913"><strong id="dis_02_0025__b472105120291">ADVANCED</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0025__row12561351192911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p2722512293">partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p1172105112915">Array of <a href="#dis_02_0025__response_PartitionResult">PartitionResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p8731251182913">A list of partitions that comprise the DIS stream.</p>
</td>
</tr>
<tr id="dis_02_0025__row10561751162910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p10736515298">has_more_partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p137315152910">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p10741651142913">Whether there are more matching partitions</p>
<ul id="dis_02_0025__ul117417519298"><li id="dis_02_0025__li14742051122912"><strong id="dis_02_0025__b1574351132912">true</strong>: yes</li><li id="dis_02_0025__li6747519291"><strong id="dis_02_0025__b97510517291">false</strong>: no</li></ul>
</td>
</tr>
<tr id="dis_02_0025__row85615513298"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p775155192920">retention_period</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p177505172911">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p1275151142915">Period for storing data in units of hours.</p>
</td>
</tr>
<tr id="dis_02_0025__row65765116291"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p976115112292">stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p2761851112916">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p877135119294">Unique identifier of the stream.</p>
</td>
</tr>
<tr id="dis_02_0025__row105785119291"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p57715162916">data_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p197755182910">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p27885118291">Source data type</p>
<ul id="dis_02_0025__ul67825172918"><li id="dis_02_0025__li157895172910"><strong id="dis_02_0025__b87915152911">BLOB</strong>: a collection of binary data stored as a single entity in a database management system</li></ul>
<p id="dis_02_0025__p18075172915">Default value: <strong id="dis_02_0025__b1280175122914">BLOB</strong></p>
<p id="dis_02_0025__p19801351152910">Enumeration values:</p>
<ul id="dis_02_0025__ul1080251132911"><li id="dis_02_0025__li12802510291"><strong id="dis_02_0025__b138015514293">BLOB</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0025__row1357135115291"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p1284145119298">compression_format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p1851512297">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p3857516296">Data compression type. The following types are available:</p>
<ul id="dis_02_0025__ul12856516291"><li id="dis_02_0025__li8851451192918">snappy</li><li id="dis_02_0025__li6865511295">gzip</li><li id="dis_02_0025__li1586451102915">zip</li></ul>
<p id="dis_02_0025__p18871751182913">Data is not compressed by default.</p>
<p id="dis_02_0025__p17871511294">Enumeration values:</p>
<ul id="dis_02_0025__ul787751132918"><li id="dis_02_0025__li12871551182910"><strong id="dis_02_0025__b1388185119292">snappy</strong></li><li id="dis_02_0025__li13881751102917"><strong id="dis_02_0025__b138865114293">gzip</strong></li><li id="dis_02_0025__li1188185118291"><strong id="dis_02_0025__b888251112917">zip</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0025__row12571951172914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p1390651132919">writable_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p189010516292">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p1092351112918">Total number of writable partitions (including partitions in ACTIVE state only).</p>
</td>
</tr>
<tr id="dis_02_0025__row157451162917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p092951202915">readable_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p189445115297">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p89416512293">Total number of readable partitions (including partitions in ACTIVE and DELETED state).</p>
</td>
</tr>
<tr id="dis_02_0025__row45735172911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p109513514299">update_partition_counts</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p18958512295">Array of <a href="#dis_02_0025__response_UpdatePartitionCount">UpdatePartitionCount</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p596351192911">List of scaling operation records.</p>
</td>
</tr>
<tr id="dis_02_0025__row057105117290"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p1196151202913">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p296251142914">Array of <a href="#dis_02_0025__response_Tag">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p139745112291">List of stream tags.</p>
</td>
</tr>
<tr id="dis_02_0025__row135725112914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p098185122910">sys_tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p1098175119292">Array of <a href="#dis_02_0025__response_SysTag">SysTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p99815192920">Enterprise project of a stream.</p>
</td>
</tr>
<tr id="dis_02_0025__row7581551142918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p699851192918">auto_scale_enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p1799145172917">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p510065114298">Whether to enable auto scaling</p>
<ul id="dis_02_0025__ul7100165118296"><li id="dis_02_0025__li101001251192913"><strong id="dis_02_0025__b121001517296">true</strong>: Auto scaling is enabled.</li><li id="dis_02_0025__li510019519296"><strong id="dis_02_0025__b1810155112293">false</strong>: Auto scaling is disabled.</li></ul>
<p id="dis_02_0025__p1110125162918">By default, this function is disabled.</p>
</td>
</tr>
<tr id="dis_02_0025__row15581251142919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p12102135112299">auto_scale_min_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p121027513298">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p19103135117296">Minimum number of partitions for automatic scale-down when auto scaling is enabled.</p>
</td>
</tr>
<tr id="dis_02_0025__row1758205117293"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0025__p2103551102915">auto_scale_max_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0025__p21042051122913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0025__p1104951122919">Maximum number of partitions for automatic scale-up when auto scaling is enabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0025__response_PartitionResult"></a><a name="response_PartitionResult"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__response_PartitionResult" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PartitionResult</caption><thead align="left"><tr id="dis_02_0025__row17105151192913"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="dis_02_0025__p14106155162911">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_0025__p19107551112920">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_0025__p18107185115292">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row5105105172918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0025__p111071519299">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0025__p1510875112914">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0025__p181081451112911">Current status of the partition</p>
<ul id="dis_02_0025__ul151081051182910"><li id="dis_02_0025__li81084517296"><strong id="dis_02_0025__b8109051202910">CREATING</strong>: creating</li><li id="dis_02_0025__li18109195112911"><strong id="dis_02_0025__b110985112296">ACTIVE</strong>: available</li><li id="dis_02_0025__li610905142910"><strong id="dis_02_0025__b19109145132914">DELETED</strong>: deleted</li><li id="dis_02_0025__li711085152916"><strong id="dis_02_0025__b4110195113294">EXPIRED</strong>: expired</li></ul>
<p id="dis_02_0025__p41107515291">Enumeration values:</p>
<ul id="dis_02_0025__ul12110115192915"><li id="dis_02_0025__li1611125192911"><strong id="dis_02_0025__b811165120299">CREATING</strong></li><li id="dis_02_0025__li131111751112920"><strong id="dis_02_0025__b5111135142918">ACTIVE</strong></li><li id="dis_02_0025__li61112519296"><strong id="dis_02_0025__b31111512296">DELETED</strong></li><li id="dis_02_0025__li1611115110290"><strong id="dis_02_0025__b111255162915">EXPIRED</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0025__row111051851142920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0025__p1611265142915">partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0025__p01121051182918">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0025__p1711295142917">Unique identifier of the partition.</p>
</td>
</tr>
<tr id="dis_02_0025__row1510505142912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0025__p211365122916">hash_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0025__p1611395117298">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0025__p171131051132913">Possible value range of the hash key used by the partition.</p>
</td>
</tr>
<tr id="dis_02_0025__row9105251122916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0025__p2011445182918">sequence_number_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0025__p2011465122910">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0025__p17114151112916">Sequence number range of the partition.</p>
</td>
</tr>
<tr id="dis_02_0025__row1610515152919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0025__p411565118290">parent_partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0025__p14116115114292">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0025__p411645118298">Parent partition.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0025__response_UpdatePartitionCount"></a><a name="response_UpdatePartitionCount"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__response_UpdatePartitionCount" frame="border" border="1" rules="all"><caption><b>Table 6 </b>UpdatePartitionCount</caption><thead align="left"><tr id="dis_02_0025__row1812117516299"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="dis_02_0025__p4348145113291">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_0025__p1348651142912">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_0025__p834818513299">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row18122115117293"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0025__p13348105132916">create_timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0025__p334975111298">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0025__p1134912516294">Scaling execution timestamp, which is a 13-digit timestamp.</p>
</td>
</tr>
<tr id="dis_02_0025__row1912295122915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0025__p5349135110297">src_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0025__p1134965115291">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0025__p93491518290">Number of partitions before scaling.</p>
</td>
</tr>
<tr id="dis_02_0025__row1212216518291"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0025__p3349185114298">target_partition_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0025__p193491651152915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0025__p4349551162913">Number of partitions after scaling.</p>
</td>
</tr>
<tr id="dis_02_0025__row812213517297"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0025__p17350151102914">result_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0025__p1350951102919">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0025__p1035095115298">Response code of the scaling operation.</p>
</td>
</tr>
<tr id="dis_02_0025__row41228513296"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0025__p1335195162911">result_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0025__p635112517299">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0025__p935116512293">Response to the scaling operation.</p>
</td>
</tr>
<tr id="dis_02_0025__row1712210517292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dis_02_0025__p193514510293">auto_scale</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dis_02_0025__p53521351132916">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dis_02_0025__p1235212519294">Whether the scaling operation is automatic</p>
<ul id="dis_02_0025__ul16352351102917"><li id="dis_02_0025__li15352195116298"><strong id="dis_02_0025__b13525510296">true</strong>: auto scaling</li><li id="dis_02_0025__li435285132912"><strong id="dis_02_0025__b5353051102911">false</strong>: manual scaling</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0025__response_Tag"></a><a name="response_Tag"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__response_Tag" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Tag</caption><thead align="left"><tr id="dis_02_0025__row212918512299"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="dis_02_0025__p15353251152911">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_0025__p103535519290">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_0025__p1135335102911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row112955115295"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dis_02_0025__p2353135122912">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dis_02_0025__p1235685112299">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dis_02_0025__p10356651112912">Key</p>
<ul id="dis_02_0025__ul10356125117292"><li id="dis_02_0025__li4356551182919">It cannot be left blank.</li><li id="dis_02_0025__li43561051142912">It must be unique for each resource.</li><li id="dis_02_0025__li7356135112293">It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</li></ul>
<p id="dis_02_0025__p12356115113296">Minimum: <strong id="dis_02_0025__b135645111293">1</strong></p>
<p id="dis_02_0025__p735735152913">Maximum: <strong id="dis_02_0025__b8357251162916">36</strong></p>
</td>
</tr>
<tr id="dis_02_0025__row9129195132915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dis_02_0025__p5358195113292">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dis_02_0025__p183587512294">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dis_02_0025__p9359195172912">Value</p>
<ul id="dis_02_0025__ul123592514291"><li id="dis_02_0025__li63591351182916">It can contain a maximum of 43 characters.</li><li id="dis_02_0025__li835985115297">It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).</li><li id="dis_02_0025__li235975192911">It can only contain digits, letters, hyphens (-), and underscores (_).</li></ul>
<p id="dis_02_0025__p15359651112917">Minimum: <strong id="dis_02_0025__b17359951122915">0</strong></p>
<p id="dis_02_0025__p123601551192916">Maximum: <strong id="dis_02_0025__b936095112293">43</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0025__response_SysTag"></a><a name="response_SysTag"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__response_SysTag" frame="border" border="1" rules="all"><caption><b>Table 8 </b>SysTag</caption><thead align="left"><tr id="dis_02_0025__row41341151192916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="dis_02_0025__p236065110295">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="dis_02_0025__p1360155117293">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="dis_02_0025__p1436013519296">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row1613515114292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="dis_02_0025__p1136015162911">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="dis_02_0025__p03609516296">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="dis_02_0025__p036185172919">Key</p>
<ul id="dis_02_0025__ul736118511291"><li id="dis_02_0025__li19361155112919">It cannot be left blank.</li><li id="dis_02_0025__li136135116299">Its value must be <strong id="dis_02_0025__b936195152910">_sys_enterprise_project_id</strong>.</li></ul>
<p id="dis_02_0025__p1236185115290">Enumeration values:</p>
<ul id="dis_02_0025__ul15364551152913"><li id="dis_02_0025__li5364145110298"><strong id="dis_02_0025__b15365175118299">_sys_enterprise_project_id</strong></li></ul>
</td>
</tr>
<tr id="dis_02_0025__row10135051182920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="dis_02_0025__p836616519298">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="dis_02_0025__p23660519292">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="dis_02_0025__p3366451132913">Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.</p>
<ul id="dis_02_0025__ul1836610512296"><li id="dis_02_0025__li1636615117295">It is a 36-digit UUID.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0025__section836795182910"><h4 class="sectiontitle">Example Requests</h4><p id="dis_02_0025__p11367125114292">Querying Stream Details</p>
<pre class="screen" id="dis_02_0025__screen133671951142917">GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}</pre>
</div>
<div class="section" id="dis_02_0025__section173679510299"><h4 class="sectiontitle">Example Responses</h4><p id="dis_02_0025__p13671251182915"><strong id="dis_02_0025__b1036705117299">Status code: 200</strong></p>
<p id="dis_02_0025__p113674516299">Normal response.</p>
<pre class="screen" id="dis_02_0025__screen136845111297">{
"stream_id" : "8QM3Nt9YTLOwtUVYJhO",
"stream_name" : "newstream",
"create_time" : 1593569685875,
"last_modified_time" : "1599050091026,",
"retention_period" : 24,
"status" : "RUNNING",
"stream_type" : "COMMON",
"data_type" : "BLOB",
"writable_partition_count" : 1,
"readable_partition_count" : 1,
"tags" : [ ],
"auto_scale_enabled" : false,
"auto_scale_min_partition_count" : 0,
"auto_scale_max_partition_count" : 0,
"partitions" : [ {
"status" : "ACTIVE",
"partition_id" : "shardId-0000000000",
"hash_range" : "[0 : 9223372036854775807]",
"sequence_number_range" : "[289911 : 289927]"
} ],
"has_more_partitions" : false
}</pre>
</div>
<div class="section" id="dis_02_0025__section11370195142910"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0025__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="dis_02_0025__row415275142914"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="dis_02_0025__p8370151172911">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_0025__p33701251132919">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0025__row1315225142914"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="dis_02_0025__p737013512295">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="dis_02_0025__p183701651122916">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0025__section337085118291"><h4 class="sectiontitle">Error Codes</h4><p id="dis_02_0025__p137115512293">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