forked from laiweijian4/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>
196 lines
14 KiB
HTML
196 lines
14 KiB
HTML
<a name="ListTransferTasks"></a><a name="ListTransferTasks"></a>
|
|
|
|
<h1 class="topictitle1">Querying Dump Task</h1>
|
|
<div id="body27001047115411"><div class="section" id="ListTransferTasks__section6701174745415"><h4 class="sectiontitle">Function</h4><p id="ListTransferTasks__p77024475543">This API is used to query dump tasks.</p>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section14704124712543"><h4 class="sectiontitle">URI</h4><p id="ListTransferTasks__p1670684785410">GET /v2/{project_id}/streams/{stream_name}/transfer-tasks</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTransferTasks__table117103479548" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ListTransferTasks__row15707847125416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListTransferTasks__p9712247145410">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListTransferTasks__p371304712548">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListTransferTasks__p17714347155415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListTransferTasks__p771534719545">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListTransferTasks__row117081847125417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListTransferTasks__p17716154716541">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListTransferTasks__p137179479548">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListTransferTasks__p1371884755412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListTransferTasks__p1171814711544">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row4708164795417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListTransferTasks__p12719164716544">stream_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListTransferTasks__p177204478548">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListTransferTasks__p10721124715411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListTransferTasks__p772274775412">Name of the stream to be queried.</p>
|
|
<p id="ListTransferTasks__p18722114755410">Maximum: <strong id="ListTransferTasks__b14723154745420">60</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section872354718542"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTransferTasks__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ListTransferTasks__row7724124718544"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListTransferTasks__p16725204718547">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListTransferTasks__p1672674720541">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListTransferTasks__p67275479547">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListTransferTasks__p7728204719549">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListTransferTasks__row10724047205418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListTransferTasks__p1972844719545">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListTransferTasks__p1672954735417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListTransferTasks__p3730134735418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListTransferTasks__p873020474547">User token.</p>
|
|
<p id="ListTransferTasks__p16731104712548">The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section1373174785413"><h4 class="sectiontitle">Response Parameters</h4><p id="ListTransferTasks__p8732347165414"><strong id="ListTransferTasks__b1073274716549">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTransferTasks__response_ListTransferTasksResult" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListTransferTasks__row8732194715547"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListTransferTasks__p47331247205416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListTransferTasks__p177348476548">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListTransferTasks__p11735124716542">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListTransferTasks__row8732104745418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListTransferTasks__p47351447185411">total_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListTransferTasks__p7736104710543">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListTransferTasks__p4736104735410">Total number of dump tasks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row1473310475541"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListTransferTasks__p1473764745414">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListTransferTasks__p27371847145413">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListTransferTasks__p473794775418">Maximum number of dump tasks that can be created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row10733184714548"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListTransferTasks__p8738204715540">tasks</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListTransferTasks__p473819473541">Array of <a href="#ListTransferTasks__response_TransferTask">TransferTask</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListTransferTasks__p67391247135414">List of dump tasks.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListTransferTasks__response_TransferTask"></a><a name="response_TransferTask"></a><table cellpadding="4" cellspacing="0" summary="" id="ListTransferTasks__response_TransferTask" frame="border" border="1" rules="all"><caption><b>Table 4 </b>TransferTask</caption><thead align="left"><tr id="ListTransferTasks__row16739194714548"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListTransferTasks__p874144705413">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListTransferTasks__p9741124775415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListTransferTasks__p0741547105410">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListTransferTasks__row127402478544"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTransferTasks__p1374274715549">task_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTransferTasks__p274394719543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTransferTasks__p1074319479540">Name of the dump task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row3740847115419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTransferTasks__p774404735412">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTransferTasks__p1744134755419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTransferTasks__p1574524716549">Dump task status. Possible values:</p>
|
|
<ul id="ListTransferTasks__ul17745147155414"><li id="ListTransferTasks__li12745747115419">ERROR: An error occurs.</li><li id="ListTransferTasks__li12746174735415">STARTING: The dump task is being started.</li><li id="ListTransferTasks__li9746144710547">PAUSED: The dump task has been stopped.</li><li id="ListTransferTasks__li7747144745410">RUNNING: The dump task is running.</li><li id="ListTransferTasks__li18747124712545">DELETE: The dump task has been deleted.</li><li id="ListTransferTasks__li474844711546">ABNORMAL: The dump task is abnormal.</li></ul>
|
|
<p id="ListTransferTasks__p1674854745419">Enumeration values:</p>
|
|
<ul id="ListTransferTasks__ul374994711548"><li id="ListTransferTasks__li1749144735415"><strong id="ListTransferTasks__b174912472548">ERROR</strong></li><li id="ListTransferTasks__li1074934715544"><strong id="ListTransferTasks__b10749144717544">STARTING</strong></li><li id="ListTransferTasks__li15750134775411"><strong id="ListTransferTasks__b6750114705417">PAUSED</strong></li><li id="ListTransferTasks__li1375054735418"><strong id="ListTransferTasks__b17750164717549">RUNNING</strong></li><li id="ListTransferTasks__li107501047115412"><strong id="ListTransferTasks__b1975144755416">DELETE</strong></li><li id="ListTransferTasks__li67511847125412"><strong id="ListTransferTasks__b16751204711546">ABNORMAL</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row13740647165417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTransferTasks__p18751174745419">destination_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTransferTasks__p3752747175418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTransferTasks__p10752144735418">Dump destination. Possible values:</p>
|
|
<ul id="ListTransferTasks__ul1753194714548"><li id="ListTransferTasks__li27532472546">OBS: Data is dumped to OBS.</li></ul>
|
|
<p id="ListTransferTasks__p1775517479541">Enumeration values:</p>
|
|
<ul id="ListTransferTasks__ul2075664795419"><li id="ListTransferTasks__li14756124717544"><strong id="ListTransferTasks__b1775854765412">OBS</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row157401247195413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTransferTasks__p77611147135411">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTransferTasks__p1676116475542">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTransferTasks__p276115477545">Time when the dump task is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListTransferTasks__row17740194718546"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListTransferTasks__p876224725410">last_transfer_timestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListTransferTasks__p27621847145416">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListTransferTasks__p1176317478547">Latest dump time of the dump task.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section15763947145414"><h4 class="sectiontitle">Example Requests</h4><p id="ListTransferTasks__p176410475546">Querying Dump Tasks</p>
|
|
<pre class="screen" id="ListTransferTasks__screen6764124755411">GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks</pre>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section14764124710549"><h4 class="sectiontitle">Example Responses</h4><p id="ListTransferTasks__p376584713544"><strong id="ListTransferTasks__b11765104718548">Status code: 200</strong></p>
|
|
<p id="ListTransferTasks__p3765134755413">Normal response.</p>
|
|
<pre class="screen" id="ListTransferTasks__screen16766114717545">{
|
|
"tasks" : [ {
|
|
"task_id" : "As805BudhcH1lDs6gbn",
|
|
"destination_type" : "OBS",
|
|
"task_name" : "newtask",
|
|
"create_time" : 1606554932552,
|
|
"state" : "RUNNING",
|
|
"last_transfer_timestamp" : 1606984428612
|
|
} ],
|
|
"total_number" : 1
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section107701747115414"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListTransferTasks__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListTransferTasks__row2077017470543"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListTransferTasks__p14771174735414">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListTransferTasks__p677174715547">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListTransferTasks__row13770144775418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListTransferTasks__p19772104715417">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListTransferTasks__p147721947155414">Normal response.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListTransferTasks__section1277284745410"><h4 class="sectiontitle">Error Codes</h4><p id="ListTransferTasks__p19773547155418">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_300000004.html">Dump Task Management</a></div>
|
|
</div>
|
|
</div>
|
|
|