forked from docs/doc-exports
Xiong, Chen Xiao
83fa2f6615
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>
173 lines
12 KiB
HTML
173 lines
12 KiB
HTML
<a name="ShowCheckpoint"></a><a name="ShowCheckpoint"></a>
|
|
|
|
<h1 class="topictitle1">Querying Checkpoint Details</h1>
|
|
<div id="body371145664418"><div class="section" id="ShowCheckpoint__section197111556114420"><h4 class="sectiontitle">Function</h4><p id="ShowCheckpoint__p12711115664414">This API is used to query checkpoint details.</p>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section37121056164414"><h4 class="sectiontitle">URI</h4><p id="ShowCheckpoint__p47131056104411">GET /v2/{project_id}/checkpoints</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowCheckpoint__table19716195694416" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowCheckpoint__row971585617449"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowCheckpoint__p1671785684411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowCheckpoint__p157171556174419">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowCheckpoint__p18718185613442">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowCheckpoint__p1571818562447">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowCheckpoint__row27158562446"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowCheckpoint__p571918562448">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowCheckpoint__p171945615445">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowCheckpoint__p1071905618442">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowCheckpoint__p672014568445">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowCheckpoint__table07225569443" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ShowCheckpoint__row972135684420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ShowCheckpoint__p197228569448">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ShowCheckpoint__p10723856154414">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ShowCheckpoint__p5723155644410">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ShowCheckpoint__p1572411568444">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowCheckpoint__row1172113564442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowCheckpoint__p3724195614447">stream_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowCheckpoint__p10724105620449">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowCheckpoint__p187251567442">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowCheckpoint__p272518561440">Name of the stream to which the checkpoint belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowCheckpoint__row197211156174415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowCheckpoint__p1725145604415">partition_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowCheckpoint__p1726135624412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowCheckpoint__p117261856174416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowCheckpoint__p10739162019116">Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:- shardId-0000000000- 0</p>
|
|
<p id="ShowCheckpoint__p572785624418">For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowCheckpoint__row18721256184418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowCheckpoint__p147279564447">app_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowCheckpoint__p16728356124413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowCheckpoint__p472885604414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowCheckpoint__p11728125624412">Name of the app associated with the checkpoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowCheckpoint__row172115616449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowCheckpoint__p172895619445">checkpoint_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowCheckpoint__p117291156164411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowCheckpoint__p772995615446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowCheckpoint__p473025634413">Type of the checkpoint</p>
|
|
<ul id="ShowCheckpoint__ul3730145612444"><li id="ShowCheckpoint__li4730155614414"><strong id="ShowCheckpoint__b77309562441">LAST_READ</strong>: Only sequence numbers are recorded in databases.</li></ul>
|
|
<p id="ShowCheckpoint__p2730185614447">Enumeration values:</p>
|
|
<ul id="ShowCheckpoint__ul873195618441"><li id="ShowCheckpoint__li87317567446"><strong id="ShowCheckpoint__b20731145664417">LAST_READ</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section147315567442"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowCheckpoint__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ShowCheckpoint__row11732115664419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowCheckpoint__p13733656134418">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowCheckpoint__p15734115616441">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowCheckpoint__p17734125614448">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowCheckpoint__p1773415644414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowCheckpoint__row373216565442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowCheckpoint__p1573575624410">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowCheckpoint__p1473520564449">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowCheckpoint__p2735165616443">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowCheckpoint__p147361056144413">User token</p>
|
|
<p id="ShowCheckpoint__p15736115684419">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ShowCheckpoint__b27365562449">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section12736205614444"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowCheckpoint__p9736115614443"><strong id="ShowCheckpoint__b0736195612449">Status code: 204</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowCheckpoint__response_GetCheckpointResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowCheckpoint__row1273716564442"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowCheckpoint__p6738155644410">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowCheckpoint__p47381568442">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowCheckpoint__p47382056104418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowCheckpoint__row1973755617447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowCheckpoint__p11739185611448">sequence_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowCheckpoint__p20739185644418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowCheckpoint__p1739155611443">Sequence number used to record the consumption checkpoint of the stream.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowCheckpoint__row1737115610444"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowCheckpoint__p8740115619448">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowCheckpoint__p15740175654412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowCheckpoint__p137411256134413">Metadata information of the consumer application.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section127411056134410"><h4 class="sectiontitle">Example Requests</h4><p id="ShowCheckpoint__p1741456194418">Querying Checkpoint Details</p>
|
|
<pre class="screen" id="ShowCheckpoint__screen97428564449">GET https://{Endpoint}/v2/{project_id}/checkpoints</pre>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section374318565445"><h4 class="sectiontitle">Example Responses</h4><p id="ShowCheckpoint__p1174314565445"><strong id="ShowCheckpoint__b19743205611449">Status code: 204</strong></p>
|
|
<p id="ShowCheckpoint__p1274413565448">Normal response.</p>
|
|
<pre class="screen" id="ShowCheckpoint__screen2744956154419">{
|
|
"sequence_number" : "newstram",
|
|
"metadata" : ""
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section27451456114413"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowCheckpoint__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowCheckpoint__row1174635611441"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowCheckpoint__p0746115610445">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowCheckpoint__p15747155614449">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowCheckpoint__row18746356174414"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowCheckpoint__p47472568444">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowCheckpoint__p5747165634411">Normal response.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowCheckpoint__section1874795614420"><h4 class="sectiontitle">Error Codes</h4><p id="ShowCheckpoint__p6748356174417">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_300000002.html">Checkpoint Management</a></div>
|
|
</div>
|
|
</div>
|
|
|