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

144 lines
10 KiB
HTML
Raw Blame History

<a name="DeleteCheckpoint"></a><a name="DeleteCheckpoint"></a>
<h1 class="topictitle1">Deleting Checkpoints</h1>
<div id="body1117911004710"><div class="section" id="DeleteCheckpoint__section8179410124710"><h4 class="sectiontitle">Function</h4><p id="DeleteCheckpoint__p7179161024715">This API is used to delete checkpoints.</p>
</div>
<div class="section" id="DeleteCheckpoint__section161812102476"><h4 class="sectiontitle">URI</h4><p id="DeleteCheckpoint__p12181171024717">DELETE /v2/{project_id}/checkpoints</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCheckpoint__table171833104475" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteCheckpoint__row718271018473"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteCheckpoint__p618319104479">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteCheckpoint__p718421024718">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteCheckpoint__p201847106476">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteCheckpoint__p818512102477">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCheckpoint__row6182191020471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteCheckpoint__p141861310184713">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteCheckpoint__p121875107476">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteCheckpoint__p2187121010479">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteCheckpoint__p8188141015475">Project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCheckpoint__table21911610104718" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="DeleteCheckpoint__row18189710184710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="DeleteCheckpoint__p111911510184710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="DeleteCheckpoint__p3191610154715">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="DeleteCheckpoint__p11921510134717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="DeleteCheckpoint__p11192131019471">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCheckpoint__row2190410144713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteCheckpoint__p7192101074712">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteCheckpoint__p6193171010471">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteCheckpoint__p21937105473">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteCheckpoint__p191938107476">Name of the stream to which the checkpoint belongs.</p>
</td>
</tr>
<tr id="DeleteCheckpoint__row41901104472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteCheckpoint__p1619431014720">app_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteCheckpoint__p1019413107471">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteCheckpoint__p5194710184715">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteCheckpoint__p16195910154710">Name of the application associated with the checkpoint.</p>
<p id="DeleteCheckpoint__p1819515103475">Minimum: <strong id="DeleteCheckpoint__b1319531054710">1</strong></p>
<p id="DeleteCheckpoint__p101951103476">Maximum: <strong id="DeleteCheckpoint__b1719620105473">50</strong></p>
</td>
</tr>
<tr id="DeleteCheckpoint__row119051014472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteCheckpoint__p7196131094718">checkpoint_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteCheckpoint__p16196161013470">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteCheckpoint__p919717104473">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteCheckpoint__p1619791015475">Type of the checkpoint</p>
<ul id="DeleteCheckpoint__ul1619771054717"><li id="DeleteCheckpoint__li41971910164719"><strong id="DeleteCheckpoint__b1319871011476">LAST_READ</strong>: Only sequence numbers are recorded in databases.</li></ul>
<p id="DeleteCheckpoint__p51981910124719">Enumeration values:</p>
<ul id="DeleteCheckpoint__ul7198610124714"><li id="DeleteCheckpoint__li151980101477"><strong id="DeleteCheckpoint__b101985105471">LAST_READ</strong></li></ul>
</td>
</tr>
<tr id="DeleteCheckpoint__row419011013479"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="DeleteCheckpoint__p9199510164717">partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="DeleteCheckpoint__p5199610114718">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="DeleteCheckpoint__p019931019473">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="DeleteCheckpoint__p082025517214">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="DeleteCheckpoint__p72004103479">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>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCheckpoint__section1820071017476"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCheckpoint__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="DeleteCheckpoint__row520161011479"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteCheckpoint__p8202210174719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteCheckpoint__p192023107470">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteCheckpoint__p182021210194710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteCheckpoint__p19203181074717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCheckpoint__row62011410174710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteCheckpoint__p19203810144715">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteCheckpoint__p16203191074719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteCheckpoint__p920451015479">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteCheckpoint__p620451074712">User token</p>
<p id="DeleteCheckpoint__p19205181011475">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="DeleteCheckpoint__b17205171014470">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCheckpoint__section0205121064717"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteCheckpoint__p1420519101472">None</p>
</div>
<div class="section" id="DeleteCheckpoint__section22061710124718"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteCheckpoint__p152061110174714">Deleting Checkpoints</p>
<pre class="screen" id="DeleteCheckpoint__screen1420615101470">DELETE https://{Endpoint}/v2/{project_id}/checkpoints</pre>
</div>
<div class="section" id="DeleteCheckpoint__section520711015470"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteCheckpoint__p3207110164716">None</p>
</div>
<div class="section" id="DeleteCheckpoint__section152071910184710"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCheckpoint__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteCheckpoint__row62082104477"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteCheckpoint__p112095103471">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteCheckpoint__p11209171013478">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteCheckpoint__row1320814104479"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteCheckpoint__p14210510194712">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteCheckpoint__p5210210124720">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteCheckpoint__section021011105478"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteCheckpoint__p14211121016477">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>
View Git Blame Copy Permalink