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

276 lines
19 KiB
HTML
Raw Blame History

<a name="ShowConsumerState"></a><a name="ShowConsumerState"></a>
<h1 class="topictitle1">Querying App Consumption Status</h1>
<div id="body975742713537"><div class="section" id="ShowConsumerState__section5757122714536"><h4 class="sectiontitle">Function</h4><p id="ShowConsumerState__p14758152725318">This API is used to query the consumption status of apps.</p>
</div>
<div class="section" id="ShowConsumerState__section676022713538"><h4 class="sectiontitle">URI</h4><p id="ShowConsumerState__p776072711536">GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowConsumerState__table1176292735313" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowConsumerState__row1876114278534"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowConsumerState__p11762727145319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowConsumerState__p10763112765315">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowConsumerState__p19763182715311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowConsumerState__p67641027185317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowConsumerState__row276116271533"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowConsumerState__p1076442775317">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowConsumerState__p3765122715539">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowConsumerState__p197651927165317">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowConsumerState__p6766112715313">Project ID.</p>
</td>
</tr>
<tr id="ShowConsumerState__row97611727115318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowConsumerState__p276632715315">app_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowConsumerState__p5767172715535">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowConsumerState__p1276710273538">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowConsumerState__p1676812795316">Name of the app to be queried.</p>
</td>
</tr>
<tr id="ShowConsumerState__row676122710538"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowConsumerState__p1976911273534">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowConsumerState__p10769182718535">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowConsumerState__p1377002717530">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowConsumerState__p37711277539">Name of the stream to be queried.</p>
<p id="ShowConsumerState__p67711827145314">Maximum: <strong id="ShowConsumerState__b117721727155313">60</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowConsumerState__table1577382719538" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ShowConsumerState__row1772182755311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ShowConsumerState__p5774192719532">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ShowConsumerState__p1477432715314">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ShowConsumerState__p17775152795314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ShowConsumerState__p1677519272535">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowConsumerState__row15772162745311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowConsumerState__p16776627165319">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowConsumerState__p19777152717539">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowConsumerState__p17771127125317">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowConsumerState__p4778122715310">Max. number of partitions to list in a single API call. The minimum value is 1 and the maximum value is 1,000. The default value is 100.</p>
<p id="ShowConsumerState__p4778132712538">Minimum: <strong id="ShowConsumerState__b15779162735316">1</strong></p>
<p id="ShowConsumerState__p1177911276535">Maximum: <strong id="ShowConsumerState__b2779102718539">1000</strong></p>
<p id="ShowConsumerState__p1677918272531">Default: <strong id="ShowConsumerState__b1278082717533">100</strong></p>
</td>
</tr>
<tr id="ShowConsumerState__row17721427115313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowConsumerState__p078092745318">start_partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowConsumerState__p57811327155319">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowConsumerState__p17781152715535">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowConsumerState__p177821827125312">Name of the partition to start the partition list with. The returned partition list does not contain this partition.</p>
</td>
</tr>
<tr id="ShowConsumerState__row117731327115320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowConsumerState__p37820272532">checkpoint_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowConsumerState__p87831127145317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowConsumerState__p1478452785314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowConsumerState__p678413273532">Type of the checkpoint</p>
<ul id="ShowConsumerState__ul20785142718533"><li id="ShowConsumerState__li1278520271532"><strong id="ShowConsumerState__b167851127105313">LAST_READ</strong>: Only sequence numbers are recorded in databases.</li></ul>
<p id="ShowConsumerState__p197854273531">Enumeration values:</p>
<ul id="ShowConsumerState__ul197861427105313"><li id="ShowConsumerState__li1178652745318"><strong id="ShowConsumerState__b13787027155316">LAST_READ</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowConsumerState__section15787527125313"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowConsumerState__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ShowConsumerState__row5788162713538"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowConsumerState__p15789152765313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowConsumerState__p7789142735317">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowConsumerState__p18790102705315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowConsumerState__p379011277537">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowConsumerState__row178832755310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowConsumerState__p9791152735311">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowConsumerState__p07911727145319">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowConsumerState__p4792152795318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowConsumerState__p14793122716535">User token</p>
<p id="ShowConsumerState__p6793112795319">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ShowConsumerState__b579312719539">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowConsumerState__section979410277539"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowConsumerState__p1794142785313"><strong id="ShowConsumerState__b97942027135317">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowConsumerState__table1879641597" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowConsumerState__row8791347593"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowConsumerState__p6799420598">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowConsumerState__p6797455913">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowConsumerState__p13791841591">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowConsumerState__row127914465919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowConsumerState__p1797405920">has_more</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowConsumerState__p16791846597">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowConsumerState__p189552375911">Specify whether there are more matching DIS streams to list. Possible values:</p>
<ul id="ShowConsumerState__ul69514238596"><li id="ShowConsumerState__li19951223105910">true: yes</li><li id="ShowConsumerState__li14958238597">false: no</li></ul>
<p id="ShowConsumerState__p5951623165916">Default: <strong id="ShowConsumerState__b6951623165916">false</strong>.</p>
</td>
</tr>
<tr id="ShowConsumerState__row17912417592"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowConsumerState__p14888135118020">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowConsumerState__p78017410598">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowConsumerState__p1823273465914">Stream Name</p>
</td>
</tr>
<tr id="ShowConsumerState__row880204195910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowConsumerState__p1080154195910">app_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowConsumerState__p118044105912">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowConsumerState__p3801411596">App Name</p>
</td>
</tr>
<tr id="ShowConsumerState__row148011415911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowConsumerState__p13553291819">partition_consuming_states</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowConsumerState__p58014485918">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowConsumerState__p1880144105917">partition consuming state list</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowConsumerState__table13236113414212" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Partition_consuming_states</caption><thead align="left"><tr id="ShowConsumerState__row1528493411212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowConsumerState__p528420343220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowConsumerState__p82845341023">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowConsumerState__p122841342029">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowConsumerState__row1628423417210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p132841349214">partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p10284133412212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p628411341124">Partition Id</p>
</td>
</tr>
<tr id="ShowConsumerState__row52846344218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p7284834427">sequence_number</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p16284143415218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p1928411349215">Partition Sequence Number</p>
</td>
</tr>
<tr id="ShowConsumerState__row2028414344214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p1928433413210">latest_offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p428414341924">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p22842346215">partition data latest offset</p>
</td>
</tr>
<tr id="ShowConsumerState__row1828410346217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p628413345219">earliest_offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p1228493411217">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p3284193417210">partition data earliest offset</p>
</td>
</tr>
<tr id="ShowConsumerState__row52851534228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p1228543410218">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p1728533412210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p102852347214">user-defined metadata information</p>
</td>
</tr>
<tr id="ShowConsumerState__row1828510341927"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p1628533412214">checkpoint_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p828511341422">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p10285834322">Type of the checkpoint.</p>
<p id="ShowConsumerState__p628515341820">LAST_READ: Only sequence numbers are recorded in databases.</p>
<p id="ShowConsumerState__p72851234128">Enumeration values:</p>
<p id="ShowConsumerState__p132851834327">LAST_READ</p>
</td>
</tr>
<tr id="ShowConsumerState__row22850341524"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowConsumerState__p1028516341129">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowConsumerState__p92851134723">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowConsumerState__p192855341525">Partition Status:</p>
<p id="ShowConsumerState__p1828533414213">CREATING</p>
<p id="ShowConsumerState__p1628515347220">ACTIVE</p>
<p id="ShowConsumerState__p3285634521">DELETED</p>
<p id="ShowConsumerState__p428514349210">EXPIRED</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowConsumerState__section13805182714531"><h4 class="sectiontitle">Example Requests</h4><p id="ShowConsumerState__p1980662710536">Querying App Consumption Status</p>
<pre class="screen" id="ShowConsumerState__screen980719273533">GET https://{Endpoint}/v2/{project_id}/apps/{app_name}/streams/{stream_name}</pre>
</div>
<div class="section" id="ShowConsumerState__section880712710539"><h4 class="sectiontitle">Example Responses</h4><p id="ShowConsumerState__p15808162755313"><strong id="ShowConsumerState__b1180862711531">Status code: 200</strong></p>
<p id="ShowConsumerState__p15808527165320">Normal response.</p>
<pre class="screen" id="ShowConsumerState__screen980912785315">{
"stream_name" : "newstream",
"app_name" : "newapp",
"partition_consuming_states" : [ {
"partition_id" : "2",
"sequence_number" : "485",
"latest_offset" : "1000",
"earliest_offset" : "10",
"checkpoint_type" : "LAST_READ"
} ]
}</pre>
</div>
<div class="section" id="ShowConsumerState__section0813102785319"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowConsumerState__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowConsumerState__row481472713537"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowConsumerState__p10815152785312">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowConsumerState__p8815162775311">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowConsumerState__row13814112720538"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowConsumerState__p881692775310">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowConsumerState__p118164272537">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowConsumerState__section581792735313"><h4 class="sectiontitle">Error Codes</h4><p id="ShowConsumerState__p1881982720532">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>
View Git Blame Copy Permalink