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

412 lines
35 KiB
HTML
Raw Permalink Blame History

<a name="ShowTransferTask"></a><a name="ShowTransferTask"></a>
<h1 class="topictitle1">Querying Dump Task Details</h1>
<div id="body1783710194580"><div class="section" id="ShowTransferTask__section483781935816"><h4 class="sectiontitle">Function</h4><p id="ShowTransferTask__p183751985815">This API is used to query dump task details.</p>
</div>
<div class="section" id="ShowTransferTask__section2083751975816"><h4 class="sectiontitle">URI</h4><p id="ShowTransferTask__p183791955810">GET /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__table78381919165819" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ShowTransferTask__row10838171915587"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowTransferTask__p138381819145812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowTransferTask__p2083861995812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowTransferTask__p10838171965810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowTransferTask__p1483881925814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row2083851995813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowTransferTask__p183918199580">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowTransferTask__p20839141985820">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowTransferTask__p883931955812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowTransferTask__p983914192585">Project ID.</p>
</td>
</tr>
<tr id="ShowTransferTask__row3838111911583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowTransferTask__p283981914584">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowTransferTask__p584061918586">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowTransferTask__p9840191975819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowTransferTask__p12840161965811">Name of the stream.</p>
</td>
</tr>
<tr id="ShowTransferTask__row78381619155817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowTransferTask__p1484011911584">task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowTransferTask__p78404194581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowTransferTask__p384010197584">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowTransferTask__p0840121985816">Name of the dump task to be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowTransferTask__section1284113190584"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowTransferTask__row684161975817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowTransferTask__p4841319195810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowTransferTask__p10841141935817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowTransferTask__p20842161917581">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowTransferTask__p884271910585">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row88411319205810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowTransferTask__p5842201917583">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowTransferTask__p11842119115812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowTransferTask__p2842919145814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowTransferTask__p18421419105820">User token.</p>
<p id="ShowTransferTask__p1984211915589">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="ShowTransferTask__section118431319125811"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowTransferTask__p68431919205810"><strong id="ShowTransferTask__b17843121918581">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_DescribeTransferTaskResult" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowTransferTask__row3843161915583"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowTransferTask__p1784415199583">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowTransferTask__p17844161919588">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowTransferTask__p14844131913587">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row14843619145814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p4844121916589">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p16845219125815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p1584512192585">Name of the stream to which the dump task belongs.</p>
</td>
</tr>
<tr id="ShowTransferTask__row58431019165818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p11845219175819">task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p1784581975816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p18456196583">Name of the dump task.</p>
</td>
</tr>
<tr id="ShowTransferTask__row158431019165810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p1884571955810">state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p14845619195818">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p168464194589">Dump task status. Possible values:</p>
<ul id="ShowTransferTask__ul1884621918581"><li id="ShowTransferTask__li98465198585">ERROR: An error occurs.</li><li id="ShowTransferTask__li138461019135818">STARTING: The dump task is being started.</li><li id="ShowTransferTask__li158461519185810">PAUSED: The dump task has been stopped.</li><li id="ShowTransferTask__li68471919205817">RUNNING: The dump task is running.</li><li id="ShowTransferTask__li148476197582">DELETE: The dump task has been deleted.</li><li id="ShowTransferTask__li108471019145811">ABNORMAL: The dump task is abnormal.</li></ul>
<p id="ShowTransferTask__p12847101913580">Enumeration values:</p>
<ul id="ShowTransferTask__ul14847119145813"><li id="ShowTransferTask__li1384714198587"><strong id="ShowTransferTask__b584791911587">ERROR</strong></li><li id="ShowTransferTask__li13847519105812"><strong id="ShowTransferTask__b684851913581">STARTING</strong></li><li id="ShowTransferTask__li198482019165813"><strong id="ShowTransferTask__b084811985815">PAUSED</strong></li><li id="ShowTransferTask__li784871914587"><strong id="ShowTransferTask__b138488194585">RUNNING</strong></li><li id="ShowTransferTask__li184841911581"><strong id="ShowTransferTask__b188481619175813">DELETE</strong></li><li id="ShowTransferTask__li4848171911585"><strong id="ShowTransferTask__b1284881955817">ABNORMAL</strong></li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row11843151916584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p118481519145813">destination_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p5848519135810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p484961955819">Dump destination. Possible values:</p>
<ul id="ShowTransferTask__ul15849141916583"><li id="ShowTransferTask__li88491019165810">OBS: Data is dumped to OBS.</li></ul>
<p id="ShowTransferTask__p168497191581">Enumeration values:</p>
<ul id="ShowTransferTask__ul1885081915811"><li id="ShowTransferTask__li785051919581"><strong id="ShowTransferTask__b1850181935811">OBS</strong></li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row13843131915815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p168504198581">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p19850161914582">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p285118192588">Time when the dump task is created.</p>
</td>
</tr>
<tr id="ShowTransferTask__row584301925814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p38511219175818">last_transfer_timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p9851141915814">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p178511419165817">Latest dump time of the dump task.</p>
</td>
</tr>
<tr id="ShowTransferTask__row284318197582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p1485141905819">partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p16851131965815">Array of <a href="#ShowTransferTask__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="ShowTransferTask__p1685231911581">List of partition dump details.</p>
</td>
</tr>
<tr id="ShowTransferTask__row1084320198580"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowTransferTask__p985251920583">obs_destination_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowTransferTask__p985281925812"><a href="#ShowTransferTask__response_OBSDestinationDescriptorRequest">OBSDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowTransferTask__p148521019155816">Parameter list of OBS to which data in the DIS stream will be dumped.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_PartitionResult"></a><a name="response_PartitionResult"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_PartitionResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PartitionResult</caption><thead align="left"><tr id="ShowTransferTask__row38549190588"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowTransferTask__p1985541975814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowTransferTask__p285514193589">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowTransferTask__p48551319125815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row1985481975811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowTransferTask__p1385512195588">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowTransferTask__p118565198585">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowTransferTask__p17856191985819">Current status of the partition. Possible values:</p>
<ul id="ShowTransferTask__ul1885612192588"><li id="ShowTransferTask__li585615195588">CREATING: The stream is being created.</li><li id="ShowTransferTask__li118561619175815">ACTIVE: The stream is available.</li><li id="ShowTransferTask__li8856181915584">DELETED: The stream is being deleted.</li><li id="ShowTransferTask__li785691915811">EXPIRED: The stream has expired.</li></ul>
<p id="ShowTransferTask__p8856101915818">Enumeration values:</p>
<ul id="ShowTransferTask__ul385691935812"><li id="ShowTransferTask__li1857919165811"><strong id="ShowTransferTask__b6857161975818">CREATING</strong></li><li id="ShowTransferTask__li58578195587"><strong id="ShowTransferTask__b1185718197586">ACTIVE</strong></li><li id="ShowTransferTask__li19857191965812"><strong id="ShowTransferTask__b98571199581">DELETED</strong></li><li id="ShowTransferTask__li7857819145815"><strong id="ShowTransferTask__b15857111915818">EXPIRED</strong></li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row385417192583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowTransferTask__p7857131919588">partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowTransferTask__p8857619105812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowTransferTask__p18571319185814">Unique identifier of the partition.</p>
</td>
</tr>
<tr id="ShowTransferTask__row188541619135817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowTransferTask__p9858121917585">hash_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowTransferTask__p1185819193585">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowTransferTask__p9858171985817">Possible value range of the hash key used by the partition.</p>
</td>
</tr>
<tr id="ShowTransferTask__row185521915815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowTransferTask__p15858119135811">sequence_number_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowTransferTask__p19858519205810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowTransferTask__p1385811913582">Sequence number range of the partition.</p>
</td>
</tr>
<tr id="ShowTransferTask__row1855019145814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowTransferTask__p785815195588">parent_partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowTransferTask__p185931975810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowTransferTask__p10859219155816">Parent partition.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_OBSDestinationDescriptorRequest"></a><a name="response_OBSDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_OBSDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 5 </b>OBSDestinationDescriptorRequest</caption><thead align="left"><tr id="ShowTransferTask__row08591419195811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowTransferTask__p08601719135810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowTransferTask__p686031965817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowTransferTask__p98605192588">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row138591319145816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p4860819135819">task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p108601119115818">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p68618198589">Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.</p>
</td>
</tr>
<tr id="ShowTransferTask__row1859131918585"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p3861171917589">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p128611319185818">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p168611319135815">Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:</p>
<ul id="ShowTransferTask__ul08611198582"><li id="ShowTransferTask__li14861151911589">Agency Type: Cloud service</li><li id="ShowTransferTask__li19861191935820">Cloud Service: DIS</li><li id="ShowTransferTask__li5862111919580">Validity Period: unlimited</li><li id="ShowTransferTask__li148621019175811">Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.</li></ul>
<p id="ShowTransferTask__p11862419135812">If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.</p>
<p id="ShowTransferTask__p28629197583">This parameter cannot be left blank and the parameter value cannot exceed 64 characters.</p>
<p id="ShowTransferTask__p98621219175817">If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.</p>
<p id="ShowTransferTask__p168624194584">Maximum: <strong id="ShowTransferTask__b78621119105819">64</strong></p>
</td>
</tr>
<tr id="ShowTransferTask__row985941975812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p11862101965816">deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p9863191918583">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p1886315194585">User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.</p>
<p id="ShowTransferTask__p1786361919586">Value range: 30-900</p>
<p id="ShowTransferTask__p11863119145813">Default value: 300</p>
<p id="ShowTransferTask__p13863101985810">Unit: second</p>
<p id="ShowTransferTask__p88643194584">Minimum: <strong id="ShowTransferTask__b1586481925817">30</strong></p>
<p id="ShowTransferTask__p1886412196586">Maximum: <strong id="ShowTransferTask__b15864191945814">900</strong></p>
<p id="ShowTransferTask__p11864151985811">Default: <strong id="ShowTransferTask__b186411193582">300</strong></p>
</td>
</tr>
<tr id="ShowTransferTask__row38591219145816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p9864819155815">consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p386461995811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p1486461935812">Offset.</p>
<ul id="ShowTransferTask__ul17864101965813"><li id="ShowTransferTask__li198641719205810">LATEST: Maximum offset, indicating that the latest data will be extracted.</li><li id="ShowTransferTask__li28651319105813">TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.</li></ul>
<p id="ShowTransferTask__p158651219105815">Default value: LATEST</p>
<p id="ShowTransferTask__p11865719155811">Default: <strong id="ShowTransferTask__b13865141925820">LATEST</strong></p>
<p id="ShowTransferTask__p1086513195587">Enumeration values:</p>
<ul id="ShowTransferTask__ul18865119155818"><li id="ShowTransferTask__li1586551913586"><strong id="ShowTransferTask__b68656194588">LATEST</strong></li><li id="ShowTransferTask__li188651519155811"><strong id="ShowTransferTask__b486512196585">TRIM_HORIZON</strong></li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row1385916198587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p2865101918586">file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p5866111918587">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p1586681975812">Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.</p>
<p id="ShowTransferTask__p586621935815">The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).</p>
<p id="ShowTransferTask__p38661519145811">This parameter is left empty by default.</p>
<p id="ShowTransferTask__p18669192586">Maximum: <strong id="ShowTransferTask__b786601935811">50</strong></p>
</td>
</tr>
<tr id="ShowTransferTask__row17859119165818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p386671915588">partition_format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p1086614199584">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p1386612198583">Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm (time at which the dump task was created).</p>
<ul id="ShowTransferTask__ul086721915586"><li id="ShowTransferTask__li15867161912587">N/A: Leave this parameter empty, indicating that the date and time directory is not used.</li><li id="ShowTransferTask__li48671719155816">yyyy: year</li><li id="ShowTransferTask__li38671119135811">yyyy/MM: year/month</li><li id="ShowTransferTask__li486701915589">yyyy/MM/dd: year/month/day</li><li id="ShowTransferTask__li88671319205819">yyyy/MM/dd/HH: year/month/day/hour</li><li id="ShowTransferTask__li14867161945813">yyyy/MM/dd/HH/mm: year/month/day/hour/minute</li></ul>
<p id="ShowTransferTask__p286701925811">Example: in 2017/11/10/14/49, the directory structure is 2017 &gt; 11 &gt; 10 &gt; 14 &gt; 49. 2017 indicates the outermost folder.</p>
<p id="ShowTransferTask__p586841975818">Default value: empty.</p>
<p id="ShowTransferTask__p68681119155817">Note:</p>
<p id="ShowTransferTask__p586810193583">After data is successfully dumped, the directory structure is obs_bucket_path/file_prefix/partition_format.</p>
<p id="ShowTransferTask__p178682194587">Enumeration values:</p>
<ul id="ShowTransferTask__ul98689198582"><li id="ShowTransferTask__li108685194586"><strong id="ShowTransferTask__b68681919175819">yyyy</strong></li><li id="ShowTransferTask__li7868151917580"><strong id="ShowTransferTask__b128681191586">yyyy/MM</strong></li><li id="ShowTransferTask__li0868819195818"><strong id="ShowTransferTask__b3868919185814">yyyy/MM/dd</strong></li><li id="ShowTransferTask__li1086816193585"><strong id="ShowTransferTask__b086871935819">yyyy/MM/dd/HH</strong></li><li id="ShowTransferTask__li8868181995810"><strong id="ShowTransferTask__b19869171915814">yyyy/MM/dd/HH/mm</strong></li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row68595195582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p18869111920588">obs_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p118693198580">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p1786941915815">Name of the OBS bucket used to store data from the DIS stream.</p>
</td>
</tr>
<tr id="ShowTransferTask__row1985916195584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p186951916585">destination_file_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p18869141916588">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p11869919145812">Dump file format. Possible values:</p>
<ul id="ShowTransferTask__ul13177207584"><li id="ShowTransferTask__li6171220165815">Text (default)</li></ul>
<p id="ShowTransferTask__p1518102010581">Default: <strong id="ShowTransferTask__b1018620145818">text</strong></p>
<p id="ShowTransferTask__p6185206580">Enumeration values:</p>
<ul id="ShowTransferTask__ul118172035818"><li id="ShowTransferTask__li7181204582"><strong id="ShowTransferTask__b01822017586">text</strong></li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row15859719175814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p1118172019584">processing_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p9181520125819"><a href="#ShowTransferTask__response_ProcessingSchema">ProcessingSchema</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p318182055819">Dump time directory generated based on the timestamp of the source data and the configured partition_format. Directory structure of the object file written into OBS. The directory structure is in the format of yyyy/MM/dd/HH/mm.</p>
</td>
</tr>
<tr id="ShowTransferTask__row18591819165815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowTransferTask__p1918162095810">record_delimiter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowTransferTask__p91892015584">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowTransferTask__p1418720135819">Delimiter for the dump file, which is used to separate the user data that is written into the dump file.</p>
<p id="ShowTransferTask__p101817204584">Value range:</p>
<ul id="ShowTransferTask__ul1818142019581"><li id="ShowTransferTask__li118162017584">Comma (,), which is the default value</li><li id="ShowTransferTask__li1318152095817">Semicolon (;)</li><li id="ShowTransferTask__li1019720125813">Vertical bar (|)</li><li id="ShowTransferTask__li519120135818">Newline character (\n)</li></ul>
<p id="ShowTransferTask__p1619152011587">Default: <strong id="ShowTransferTask__b71915204585">\n</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_ProcessingSchema"></a><a name="response_ProcessingSchema"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_ProcessingSchema" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ProcessingSchema</caption><thead align="left"><tr id="ShowTransferTask__row1872141955811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowTransferTask__p121962095820">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowTransferTask__p91962012584">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowTransferTask__p219162035811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row1687231914584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowTransferTask__p31911206582">timestamp_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowTransferTask__p1619020155812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowTransferTask__p141922075816">Attribute name of the source data timestamp.</p>
</td>
</tr>
<tr id="ShowTransferTask__row587218199585"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowTransferTask__p719132015813">timestamp_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowTransferTask__p16191820155812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowTransferTask__p5192020175818">Type of the source data timestamp.</p>
<ul id="ShowTransferTask__ul191932025816"><li id="ShowTransferTask__li319122015819">String</li><li id="ShowTransferTask__li141992095816">Timestamp: 13-bit timestamp of the long type</li></ul>
</td>
</tr>
<tr id="ShowTransferTask__row1872119135815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowTransferTask__p17208209589">timestamp_format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowTransferTask__p5201120135814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowTransferTask__p1720122025811">OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is String.</p>
<p id="ShowTransferTask__p420820105816">Value range:</p>
<ul id="ShowTransferTask__ul4201920185813"><li id="ShowTransferTask__li2020720165817">yyyy/MM/dd HH:mm:ss</li><li id="ShowTransferTask__li220142025816">MM/dd/yyyy HH:mm:ss</li><li id="ShowTransferTask__li112011203582">dd/MM/yyyy HH:mm:ss</li><li id="ShowTransferTask__li12062095813">yyyy-MM-dd HH:mm:ss</li><li id="ShowTransferTask__li1720520185816">MM-dd-yyyy HH:mm:ss</li><li id="ShowTransferTask__li1520102011580">dd-MM-yyyy HH:mm:ss</li></ul>
<p id="ShowTransferTask__p32019208585">Enumeration values:</p>
<ul id="ShowTransferTask__ul52112015588"><li id="ShowTransferTask__li721112025816"><strong id="ShowTransferTask__b02132016585">yyyy/MM/dd HH:mm:ss</strong></li><li id="ShowTransferTask__li1821152005817"><strong id="ShowTransferTask__b1421192011583">MM/dd/yyyy HH:mm:ss</strong></li><li id="ShowTransferTask__li182122015813"><strong id="ShowTransferTask__b12172020585">dd/MM/yyyy HH:mm:ss</strong></li><li id="ShowTransferTask__li221152085810"><strong id="ShowTransferTask__b6211820135810">yyyy-MM-dd HH:mm:ss</strong></li><li id="ShowTransferTask__li1321162065816"><strong id="ShowTransferTask__b2211220145814">MM-dd-yyyy HH:mm:ss</strong></li><li id="ShowTransferTask__li192102045818"><strong id="ShowTransferTask__b22122055810">dd-MM-yyyy HH:mm:ss</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowTransferTask__section17441520155820"><h4 class="sectiontitle">Example Requests</h4><p id="ShowTransferTask__p1944122015582">Querying Dump Task Details</p>
<pre class="screen" id="ShowTransferTask__screen844122095818">GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}</pre>
</div>
<div class="section" id="ShowTransferTask__section124422017584"><h4 class="sectiontitle">Example Responses</h4><p id="ShowTransferTask__p644122035813"><strong id="ShowTransferTask__b1744132025814">Status code: 200</strong></p>
<p id="ShowTransferTask__p64462085816">Normal response.</p>
<pre class="screen" id="ShowTransferTask__screen114442025818">{
"stream_id" : "RdMFID6edQdf8eDzc9e",
"stream_name" : "newstream",
"task_name" : "newtask",
"task_id" : "As805BudhcH1lDs6gbn",
"destination_type" : "OBS",
"state" : "RUNNING",
"create_time" : 1606554932552,
"last_transfer_timestamp" : 1606984428612,
"obs_destination_description" : {
"agency_name" : "dis_admin_agency",
"file_prefix\"" : "",
"partition_format" : "yyyy/MM/dd",
"obs_bucket_path" : "obsbucket",
"deliver_time_interval" : 60,
"consumer_strategy" : "LATEST",
"retry_duration" : 0,
"destination_file_type" : "text",
"record_delimiter" : "\n"
},
"partitions" : [ {
"partitionId" : "shardId-0000000000",
"discard" : 0,
"state" : "RUNNING",
"last_transfer_timestamp" : 1606984428612,
"last_transfer_offset" : 289897
} ]
}</pre>
</div>
<div class="section" id="ShowTransferTask__section84552019586"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowTransferTask__row09331219205812"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowTransferTask__p54582011587">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowTransferTask__p174532017588">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowTransferTask__row8933181985819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowTransferTask__p34511206584">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowTransferTask__p24532016588">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowTransferTask__section9451720195811"><h4 class="sectiontitle">Error Codes</h4><p id="ShowTransferTask__p145620115811">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>
View Git Blame Copy Permalink