yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
8f01f116a5ad22cc6ad22bdf6cdc797063a2f5f1
doc-exports/docs/dis/api-ref/ShowTransferTask.html
chenxiaoxiong 5020341264 DIS API 20230918 version 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: chenxiaoxiong <chenxiaoxiong@huawei.com>
Co-committed-by: chenxiaoxiong <chenxiaoxiong@huawei.com>
2025-02-13 09:26:40 +00:00

1355 lines
80 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="ShowTransferTask"></a><a name="ShowTransferTask"></a>
<h1 class="topictitle1">Querying Dump Task Details</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query details of a dump task.</p>
</div>
<div class="section" id="ShowTransferTask__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p>For details, see <a href="dis_02_0400.html">Calling APIs</a>.</p>
</div>
<div class="section" id="ShowTransferTask__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Project ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Name of the stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Name of the dump task to be queried</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p>User token.</p>
<p>It can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Name of the stream to which the dump task belongs</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Name of the dump task</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Dump task status.</p>
<ul><li><p><strong>ERROR</strong>: An error occurs.</p>
</li><li><p><strong>STARTING</strong>: The task is starting.</p>
</li><li><p><strong>PAUSED</strong>: The task has been stopped.</p>
</li><li><p><strong>RUNNING</strong>: The task is running.</p>
</li><li><p><strong>DELETE</strong>: The task has been deleted.</p>
</li><li><p><strong>ABNORMAL</strong>: The task is abnormal.</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>ERROR</strong></p>
</li><li><p><strong>STARTING</strong></p>
</li><li><p><strong>PAUSED</strong></p>
</li><li><p><strong>RUNNING</strong></p>
</li><li><p><strong>DELETE</strong></p>
</li><li><p><strong>ABNORMAL</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>destination_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Type of the dump task.</p>
<ul><li><p><strong>OBS</strong>: Data is dumped to OBS.</p>
</li><li><p><strong>MRS</strong>: Data is dumped to MRS.</p>
</li><li><p><strong>DLI</strong>: Data is dumped to DLI.</p>
</li><li><p><strong>CLOUDTABLE</strong>: Data is dumped to CloudTable.</p>
</li><li><p><strong>DWS</strong>: Data is dumped to DWS.</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>OBS</strong></p>
</li><li><p><strong>MRS</strong></p>
</li><li><p><strong>DLI</strong></p>
</li><li><p><strong>CLOUDTABLE</strong></p>
</li><li><p><strong>DWS</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Time when the dump task is created</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>last_transfer_timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Latest dump time of the dump task</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p>Array of <a href="#ShowTransferTask__response_PartitionResult">PartitionResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>List of partition dump details</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>obs_destination_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#ShowTransferTask__response_OBSDestinationDescriptorRequest">OBSDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Parameter list of OBS to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>dws_destination_descripton</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#ShowTransferTask__response_DWSDestinationDescriptorRequest">DWSDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Parameter list of the DWS to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>mrs_destination_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#ShowTransferTask__response_MRSDestinationDescriptorRequest">MRSDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Parameter list of the MRS to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>dli_destination_description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#ShowTransferTask__response_DliDestinationDescriptorRequest">DliDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Parameter list of the DLI to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p>cloudtable_destination_descripton</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#ShowTransferTask__response_CloudtableDestinationDescriptorRequest">CloudtableDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p>Parameter list of the CloudTable 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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p>Current status of the partition</p>
<ul><li><p><strong>CREATING</strong></p>
</li><li><p><strong>ACTIVE</strong></p>
</li><li><p><strong>DELETED</strong></p>
</li><li><p><strong>EXPIRED</strong></p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>CREATING</strong></p>
</li><li><p><strong>ACTIVE</strong></p>
</li><li><p><strong>DELETED</strong></p>
</li><li><p><strong>EXPIRED</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p>partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p>Unique identifier of the partition</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p>hash_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p>Possible value range of the hash key used by the partition</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p>sequence_number_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p>Sequence number range of the partition</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p>parent_partitions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p>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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It contains 1 to 64 characters.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Name of the agency created on IAM. DIS uses an agency to access your specified resources. Agency parameter settings:- <strong>Agency Type</strong>: <strong>Cloud service</strong>- <strong>Cloud Service</strong>: <strong>DIS</strong>- <strong>Validity Period</strong>: <strong>Unlimited</strong>- Set <strong>Policy</strong> to <strong>Tenant Administrator</strong> on the OBS project in the <strong>Global service</strong> region.If agencies are available, you can use an IAM API to obtain the available agencies.This parameter cannot be left unspecified and the parameter value cannot exceed 64 characters.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 <strong>dis_admin_agency</strong>.</p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>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>Unit: second</p>
<p>Minimum: <strong>30</strong></p>
<p>Maximum: <strong>900</strong></p>
<p>Default: <strong>300</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Offset.</p>
<ul><li><p><strong>LATEST</strong>: maximum offset, indicating that the latest data will be extracted.</p>
</li><li><p><strong>TRIM_HORIZON</strong>: minimum offset, indicating that the earliest data will be extracted.</p>
</li></ul>
<p>Default: <strong>LATEST</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>LATEST</strong></p>
</li><li><p><strong>TRIM_HORIZON</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Directory to store files that will be dumped to OBS. Different directory levels are separated by slashes (/) and cannot start with slashes.</p>
<p>The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).</p>
<p>This parameter is left blank by default.</p>
<p>Maximum: <strong>50</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>partition_format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>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).- <strong>N/A</strong>: If this parameter is left blank, the time directory format will not be used.- <strong>yyyy</strong>: year.- <strong>yyyy/MM</strong>: year and month.- <strong>yyyy/MM/dd</strong>: year, month, and day.- <strong>yyyy/MM/dd/HH</strong>: year, month, day, and hour.- <strong>yyyy/MM/dd/HH/mm</strong>: year, month, day, hour, and minute.For example, if the dump task was created at 14:49 on November 10, 2017, then the directory structure is <strong>2017 &gt; 11 &gt; 10 &gt; 14 &gt; 49</strong>.Default value: emptyNote:After the data is dumped successfully, the storage directory structure is <strong>obs_bucket_path/file_prefix/partition_format</strong>.</p>
<p>Enumeration values:</p>
<ul><li><p><strong>yyyy</strong></p>
</li><li><p><strong>yyyy/MM</strong></p>
</li><li><p><strong>yyyy/MM/dd</strong></p>
</li><li><p><strong>yyyy/MM/dd/HH</strong></p>
</li><li><p><strong>yyyy/MM/dd/HH/mm</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>obs_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Name of the OBS bucket used to store the stream data</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>destination_file_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Dump file format.</p>
<ul><li><p><strong>text</strong>: This is the default value.</p>
</li><li><p><strong>parquet</strong></p>
</li><li><p><strong>carbon</strong></p>
</li></ul>
<p>Note:</p>
<p>The <strong>parquet</strong> or <strong>carbon</strong> format can be selected only when <strong>Source Data Type</strong> is set to <strong>JSON</strong> and <strong>Dump Destination</strong> is set to <strong>OBS</strong>.</p>
<p>Default: <strong>text</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>text</strong></p>
</li><li><p><strong>parquet</strong></p>
</li><li><p><strong>carbon</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>processing_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p><a href="#ShowTransferTask__response_ProcessingSchema">ProcessingSchema</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>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><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p>record_delimiter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p>Delimiter for the dump file, which is used to separate the user data that is written into the dump file.</p>
<p>Options:</p>
<ul><li><p><strong>Comma (,)</strong>: default value</p>
</li><li><p><strong>Semicolon (;)</strong></p>
</li><li><p><strong>Vertical bar (|)</strong></p>
</li><li><p><strong>Newline (\n)</strong></p>
</li></ul>
<p>Default: <strong>\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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p>timestamp_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p>Attribute name of the source data timestamp</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p>timestamp_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p>Type of the source data timestamp.</p>
<ul><li><p>String</p>
</li><li><p><strong>Timestamp</strong>: 13-bit timestamp of the long type</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p>timestamp_format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p>OBS directory generated based on the timestamp format. This parameter is mandatory when the timestamp type of the source data is <strong>String</strong>.</p>
<p>Enumeration values:</p>
<ul><li><p><strong>yyyy/MM/dd HH:mm:ss</strong></p>
</li><li><p><strong>MM/dd/yyyy HH:mm:ss</strong></p>
</li><li><p><strong>dd/MM/yyyy HH:mm:ss</strong></p>
</li><li><p><strong>yyyy-MM-dd HH:mm:ss</strong></p>
</li><li><p><strong>MM-dd-yyyy HH:mm:ss</strong></p>
</li><li><p><strong>dd-MM-yyyy HH:mm:ss</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_DWSDestinationDescriptorRequest"></a><a name="response_DWSDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_DWSDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 7 </b>DWSDestinationDescriptorRequest</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It contains 1 to 64 characters.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the agency created on IAM. DIS uses an agency to access your specified resources. Agency parameter settings:- <strong>Agency Type</strong>: <strong>Cloud service</strong>- <strong>Cloud Service</strong>: <strong>DIS</strong>- <strong>Validity Period</strong>: <strong>Unlimited</strong>- Set <strong>Policy</strong> to <strong>Tenant Administrator</strong> on the OBS project in the <strong>Global service</strong> region.If agencies are available, you can use an IAM API to obtain the available agencies.This parameter cannot be left unspecified and the parameter value cannot exceed 64 characters.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 <strong>dis_admin_agency</strong>.</p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>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>Unit: second</p>
<p>Minimum: <strong>30</strong></p>
<p>Maximum: <strong>900</strong></p>
<p>Default: <strong>300</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Offset.</p>
<ul><li><p><strong>LATEST</strong>: maximum offset, indicating that the latest data will be extracted.</p>
</li><li><p><strong>TRIM_HORIZON</strong>: minimum offset, indicating that the earliest data will be extracted.</p>
</li></ul>
<p>Default: <strong>LATEST</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>LATEST</strong></p>
</li><li><p><strong>TRIM_HORIZON</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the DWS cluster that stores the data in the stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>ID of the DWS cluster to which will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_database_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the DWS database that stores the data in the stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Schema of the DWS database to which data will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the DWS table that stores the data in the stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_delimiter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Delimiter used to separate the columns in the DWS tables into which user data is inserted.</p>
<p>The delimiter can be a comma (,), semicolon (;), or vertical bar (|).</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Username of the DWS database to which data will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>user_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Password of the DWS database to which data will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>kms_user_key_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the key created in KMS and used to encrypt the password of the DWS database</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>kms_user_key_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>ID of the key created in KMS and used to encrypt the password of the DWS database</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>obs_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Name of the OBS bucket used to temporarily store data in the DIS stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.</p>
<p>The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).</p>
<p>This parameter is left blank by default.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>retry_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Duration when you can constantly retry dumping data to DWS after the dump fails. If the duration expires but the dump still fails, the data will be backed up to the <strong>OBS bucket name/file_prefix/dws_error</strong> directory.Value range: 0–7200Unit: secondDefault value: <strong>1800</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>dws_table_columns</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>Column to be dumped to the DWS table. If the value is null or empty, all columns are dumped by default. For example, c1,c2 indicates that columns c1 and c2 in the schema are dumped to DWS.</p>
<p>This parameter is left blank by default.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p>options</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p><a href="#ShowTransferTask__response_Options">Options</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p>DWS fault tolerance option (used to specify various parameters of foreign table data).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_Options"></a><a name="response_Options"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_Options" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Options</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p>fill_missing_fields</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p>Whether to set the field to <strong>Null</strong> or enable an error message to be displayed in the error table when the last field in a row of the data source file is missing during database import</p>
<p>Options:</p>
<ul><li><p>true/on</p>
</li><li><p>false/off</p>
</li></ul>
<p>Default value: <strong>false</strong> or <strong>off</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>true/on</strong></p>
</li><li><p><strong>false/off</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p>ignore_extra_data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p>Whether to ignore the extra columns when the number of fields in the data source file is greater than the number of columns defined in the external table. This parameter is used only during data import.</p>
<p>Options:</p>
<ul><li><p>true/on</p>
</li><li><p>false/off</p>
</li></ul>
<p>Default value: <strong>false</strong> or <strong>off</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>true/on</strong></p>
</li><li><p><strong>false/off</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p>compatible_illegal_chars</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p>Specifies whether to tolerate invalid characters during data import. Specifies whether to convert invalid characters based on the conversion rule and import them to the database, or to report an error and stop the import.</p>
<p>Options:</p>
<ul><li><p>true/on</p>
</li><li><p>false/off</p>
</li></ul>
<p>Default value: <strong>false</strong> or <strong>off</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>true/on</strong></p>
</li><li><p><strong>false/off</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p>reject_limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p>Maximum number of data format errors allowed during the data import. If the number of data format errors does not reach the maximum, the data import is successful.</p>
<p>Options:</p>
<ul><li><p>Integer value</p>
</li><li><p><strong>unlimited</strong></p>
</li></ul>
<p>Default value: 0, indicating that an error message is returned immediately a data format error occurs.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p>error_table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p>Name of the error table that records data format errors. After the parallel import is complete, you can query the error information table to obtain the detailed error information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_MRSDestinationDescriptorRequest"></a><a name="response_MRSDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_MRSDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 9 </b>MRSDestinationDescriptorRequest</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It contains 1 to 64 characters.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Name of the agency created on IAM. DIS uses an agency to access your specified resources. Agency parameter settings:- <strong>Agency Type</strong>: <strong>Cloud service</strong>- <strong>Cloud Service</strong>: <strong>DIS</strong>- <strong>Validity Period</strong>: <strong>Unlimited</strong>- Set <strong>Policy</strong> to <strong>Tenant Administrator</strong> on the OBS project in the <strong>Global service</strong> region.If agencies are available, you can use an IAM API to obtain the available agencies.This parameter cannot be left unspecified and the parameter value cannot exceed 64 characters.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 <strong>dis_admin_agency</strong>.</p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>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>Unit: second</p>
<p>Minimum: <strong>30</strong></p>
<p>Maximum: <strong>900</strong></p>
<p>Default: <strong>300</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Offset.</p>
<ul><li><p><strong>LATEST</strong>: maximum offset, indicating that the latest data will be extracted.</p>
</li><li><p><strong>TRIM_HORIZON</strong>: minimum offset, indicating that the earliest data will be extracted.</p>
</li></ul>
<p>Default: <strong>LATEST</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>LATEST</strong></p>
</li><li><p><strong>TRIM_HORIZON</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>mrs_cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Name of the MRS cluster to which data in the DIS stream will be dumped.</p>
<p>Note:</p>
<p>Only MRS clusters with non-Kerberos authentication are supported.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>mrs_cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>ID of the MRS cluster to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>mrs_hdfs_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Hadoop Distributed File System (HDFS) path of the MRS cluster to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.</p>
<p>The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).</p>
<p>This parameter is left blank by default.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>hdfs_prefix_folder</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Directory to store files that will be dumped to the chosen MRS cluster. Different directory levels are separated by slash (/).</p>
<p>The directory name contains 0 to 50 characters.</p>
<p>This parameter is left blank by default.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>obs_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Name of the OBS bucket used to temporarily store data in the DIS stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p>retry_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p>Time duration for DIS to retry if data fails to be dumped. If the retry time exceeds the value of this parameter, the data that fails to be dumped is backed up to the <strong>OBS bucket/ file_prefix/mrs_error</strong> directory.</p>
<p>Value range: 0–7200</p>
<p>Unit: second</p>
<p>Default value: <strong>1800</strong></p>
<p>If the value is set to <strong>0</strong>, no retry is allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_DliDestinationDescriptorRequest"></a><a name="response_DliDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_DliDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 10 </b>DliDestinationDescriptorRequest</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.10.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It contains 1 to 64 characters.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Name of the agency created on IAM. DIS uses an agency to access your specified resources. Agency parameter settings:- <strong>Agency Type</strong>: <strong>Cloud service</strong>- <strong>Cloud Service</strong>: <strong>DIS</strong>- <strong>Validity Period</strong>: <strong>Unlimited</strong>- Set <strong>Policy</strong> to <strong>Tenant Administrator</strong> on the OBS project in the <strong>Global service</strong> region.If agencies are available, you can use an IAM API to obtain the available agencies.This parameter cannot be left unspecified and the parameter value cannot exceed 64 characters.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 <strong>dis_admin_agency</strong>.</p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>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>Unit: second</p>
<p>Minimum: <strong>30</strong></p>
<p>Maximum: <strong>900</strong></p>
<p>Default: <strong>300</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Offset.</p>
<ul><li><p><strong>LATEST</strong>: maximum offset, indicating that the latest data will be extracted.</p>
</li><li><p><strong>TRIM_HORIZON</strong>: minimum offset, indicating that the earliest data will be extracted.</p>
</li></ul>
<p>Default: <strong>LATEST</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>LATEST</strong></p>
</li><li><p><strong>TRIM_HORIZON</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>dli_database_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Name of the DLI database to which data in the DIS stream will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>dli_table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Name of the DLI table to which data in the DIS stream will be dumped.</p>
<p>Note:</p>
<p>Only tables whose data location is DLI are supported, and you must have the permission to insert data into the tables.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>obs_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Name of the OBS bucket used to temporarily store data in the DIS stream</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Self-defined directory created in the OBS bucket and used to temporarily store data in the DIS stream. Directory levels are separated by slashes (/) and cannot start with slashes.</p>
<p>The value can contain a maximum of 50 characters, including letters, digits, underscores (_), and slashes (/).</p>
<p>This parameter is left blank by default.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p>retry_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p>Time duration for DIS to retry if data fails to be dumped to DLI. If the retry time exceeds the value of this parameter, the data that fails to be dumped is backed up to the <strong>OBS bucket/file_prefix/dli_error</strong> directory.Value range: 0–7200Unit: secondDefault value: <strong>1800</strong>If the value is set to <strong>0</strong>, no retry is allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_CloudtableDestinationDescriptorRequest"></a><a name="response_CloudtableDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_CloudtableDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 11 </b>CloudtableDestinationDescriptorRequest</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It contains 1 to 64 characters.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Name of the agency created on IAM. DIS uses an agency to access your specified resources. Agency parameter settings:- <strong>Agency Type</strong>: <strong>Cloud service</strong>- <strong>Cloud Service</strong>: <strong>DIS</strong>- <strong>Validity Period</strong>: <strong>Unlimited</strong>- Set <strong>Policy</strong> to <strong>Tenant Administrator</strong> on the OBS project in the <strong>Global service</strong> region.If agencies are available, you can use an IAM API to obtain the available agencies.This parameter cannot be left unspecified and the parameter value cannot exceed 64 characters.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 <strong>dis_admin_agency</strong>.</p>
<p>Maximum: <strong>64</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>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>Unit: second</p>
<p>Minimum: <strong>30</strong></p>
<p>Maximum: <strong>900</strong></p>
<p>Default: <strong>300</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Offset.</p>
<ul><li><p><strong>LATEST</strong>: maximum offset, indicating that the latest data will be extracted.</p>
</li><li><p><strong>TRIM_HORIZON</strong>: minimum offset, indicating that the earliest data will be extracted.</p>
</li></ul>
<p>Default: <strong>LATEST</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>LATEST</strong></p>
</li><li><p><strong>TRIM_HORIZON</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>cloudtable_cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Name of the CloudTable cluster to which data will be dumped.</p>
<p>If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>cloudtable_cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>ID of the CloudTable cluster to which data will be dumped.</p>
<p>If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>cloudtable_table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>HBase table name of the CloudTable cluster to which data will be dumped. The parameter is mandatory when data is dumped to the CloudTable HBase.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>cloudtable_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p><a href="#ShowTransferTask__response_CloudtableSchema">CloudtableSchema</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Schema configuration of the CloudTable HBase data. You can set either this parameter or <strong>opentsdb_schema</strong>, but this parameter is mandatory when data will be dumped to HBase. After this parameter is set, the JSON data in the stream can be converted to another format and then be imported to the CloudTable HBase.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>opentsdb_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>Array of <a href="#ShowTransferTask__response_OpenTSDBSchema">OpenTSDBSchema</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Schema configuration of the CloudTable OpenTSDB data. You can set either this parameter or <strong>cloudtable_schema</strong>, but this parameter is mandatory when data will be dumped to OpenTSDB. After this parameter is set, the JSON data in the stream can be converted to another format and then be imported to the CloudTable OpenTSDB.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>cloudtable_row_key_delimiter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Delimiter used to separate the user data that generates HBase row keys. Value range: ,. |;-_~Default value: .</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>obs_backup_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Name of the OBS bucket used to back up data that failed to be dumped to CloudTable</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>backup_file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Self-defined directory created in the OBS bucket and used to back up data that failed to be dumped to CloudTable. Directory levels are separated by slashes (/) and cannot start with slashes.Value range: a string of letters, digits, and underscores (_)Maximum length: 50 charactersThis parameter is left blank by default.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p>retry_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p>Time duration for DIS to retry if data fails to be dumped to CloudTable. If the duration is exceeded but the dump still fails, the data will be backed up to <em>OBS bucket name</em>/<em>backup_file_prefix</em>/<strong>cloudtable_error</strong> or <em>OBS bucket name</em>/<em>backup_file_prefix</em>/<strong>opentsdb_error</strong>.Value range: 0–7200Unit: secondDefault value: <strong>1800</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_CloudtableSchema"></a><a name="response_CloudtableSchema"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_CloudtableSchema" frame="border" border="1" rules="all"><caption><b>Table 12 </b>CloudtableSchema</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p>row_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p>Array of <a href="#ShowTransferTask__response_RowKey">RowKey</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p>HBase rowkey schema used by the CloudTable cluster to convert JSON data into HBase rowkeys.</p>
<p>Value range:1–64</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p>columns</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p>Array of <a href="#ShowTransferTask__response_Column">Column</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p>HBase column schema used by the CloudTable cluster to convert JSON data into HBase columns.</p>
<p>Value range: 1–4096</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_RowKey"></a><a name="response_RowKey"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_RowKey" frame="border" border="1" rules="all"><caption><b>Table 13 </b>RowKey</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p>JSON attribute name, which is used to generate HBase rowkeys for JSON data in the DIS stream.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p>JSON attribute type of JSON data in the DIS stream</p>
<p>Enumeration values:</p>
<ul><li><p><strong>Bigint</strong></p>
</li><li><p><strong>Double</strong></p>
</li><li><p><strong>Boolean</strong></p>
</li><li><p><strong>Timestamp</strong></p>
</li><li><p><strong>String</strong></p>
</li><li><p><strong>Decimal</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_Column"></a><a name="response_Column"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_Column" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Column</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.14.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p>column_family_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p>Name of the HBase column family to which data will be dumped</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p>column_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p>Name of the HBase column to which data will be dumped.</p>
<p>Value range: 1–32. The value can contain only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p>JSON attribute name, which is used to generate HBase column values for JSON data in the DIS stream.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p>JSON attribute type of JSON data in the DIS stream</p>
<p>Enumeration values:</p>
<ul><li><p><strong>Bigint</strong></p>
</li><li><p><strong>Double</strong></p>
</li><li><p><strong>Boolean</strong></p>
</li><li><p><strong>Timestamp</strong></p>
</li><li><p><strong>String</strong></p>
</li><li><p><strong>Decimal</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_OpenTSDBSchema"></a><a name="response_OpenTSDBSchema"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_OpenTSDBSchema" frame="border" border="1" rules="all"><caption><b>Table 15 </b>OpenTSDBSchema</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p>metric</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p>Array of <a href="#ShowTransferTask__response_OpenTSDBMetric">OpenTSDBMetric</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p>Schema configuration of the OpenTSDB data metric in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the metric of the OpenTSDB data.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p>timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p><a href="#ShowTransferTask__response_OpenTSDBTimestamp">OpenTSDBTimestamp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p>Schema configuration of the OpenTSDB data timestamp in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the timestamp of the OpenTSDB data.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p><a href="#ShowTransferTask__response_OpenTSDBValue">OpenTSDBValue</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p>Schema configuration of the OpenTSDB data value in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the value of the OpenTSDB data.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p>tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p>Array of <a href="#ShowTransferTask__response_OpenTSDBTags">OpenTSDBTags</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p>Schema configuration of the OpenTSDB data tags in the CloudTable cluster. After this parameter is set, the JSON data in the stream can be converted to the tags of the OpenTSDB data.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_OpenTSDBMetric"></a><a name="response_OpenTSDBMetric"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_OpenTSDBMetric" frame="border" border="1" rules="all"><caption><b>Table 16 </b>OpenTSDBMetric</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.16.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><ul><li><p><strong>Constant</strong>: The value of <strong>metric</strong> is the value of <strong>Value</strong>.</p>
</li><li><p><strong>String</strong>: The value of <strong>metric</strong> is the value of the JSON attribute of the user data in the stream.</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>Constant</strong></p>
</li><li><p><strong>String</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p>Constant or JSON attribute name of the user data in the stream</p>
<p>The value contains 1 to 32 characters. Only letters, digits, and periods (.) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_OpenTSDBTimestamp"></a><a name="response_OpenTSDBTimestamp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_OpenTSDBTimestamp" frame="border" border="1" rules="all"><caption><b>Table 17 </b>OpenTSDBTimestamp</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.17.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.17.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.17.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.17.2.4.1.3 "><ul><li><p><strong>Timestamp</strong>: The value type of the JSON attribute of the user data in the stream is <strong>Timestamp</strong>, and the timestamp of OpenTSDB can be generated without converting the data format.- <strong>String</strong>: The value type of the JSON attribute of the user data in the stream is <strong>Date</strong>, and the timestamp of OpenTSDB can be generated only after the data format is converted.</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.17.2.4.1.3 "><p>JSON attribute name of the user data in the stream</p>
<p>Value range: 1–32. The value can contain only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.1 "><p>format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.17.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.17.2.4.1.3 "><p>This parameter is mandatory when <strong>type</strong> is set to <strong>String</strong>. When the value type of the JSON attribute of the user data in the stream is <strong>Date</strong>, <strong>format</strong> is required to convert the data format to generate the timestamp of OpenTSDB.Options:- yyyy/MM/dd HH:mm:ss- MM/dd/yyyy HH:mm:ss- dd/MM/yyyy HH:mm:ss- yyyy-MM-dd HH:mm:ss- MM-dd-yyyy HH:mm:ss- dd-MM-yyyy HH:mm:ss</p>
<p>Enumeration values:</p>
<ul><li><p><strong>yyyy/MM/dd HH:mm:ss</strong></p>
</li><li><p><strong>MM/dd/yyyy HH:mm:ss</strong></p>
</li><li><p><strong>dd/MM/yyyy HH:mm:ss</strong></p>
</li><li><p><strong>yyyy-MM-dd HH:mm:ss</strong></p>
</li><li><p><strong>MM-dd-yyyy HH:mm:ss</strong></p>
</li><li><p><strong>dd-MM-yyyy HH:mm:ss</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_OpenTSDBValue"></a><a name="response_OpenTSDBValue"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_OpenTSDBValue" frame="border" border="1" rules="all"><caption><b>Table 18 </b>OpenTSDBValue</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.18.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.18.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p>Type name of the JSON attribute of the user data in the stream</p>
<p>Options:</p>
<ul><li><p>Bigint</p>
</li><li><p>Double</p>
</li><li><p>Boolean</p>
</li><li><p>Timestamp</p>
</li><li><p>String</p>
</li><li><p>Decimal</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.18.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.18.2.4.1.3 "><p>Constant or JSON attribute name of the user data in the stream</p>
<p>Value range: 1–32. The value can contain only letters, digits, and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowTransferTask__response_OpenTSDBTags"></a><a name="response_OpenTSDBTags"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowTransferTask__response_OpenTSDBTags" frame="border" border="1" rules="all"><caption><b>Table 19 </b>OpenTSDBTags</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.19.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.19.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.19.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.19.2.4.1.3 "><p>Tag name of the OpenTSDB data that stores the data in the stream</p>
<p>Value range: 1–32. The value can contain only letters, digits, and underscores (_).</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.19.2.4.1.3 "><p>Type name of the JSON attribute of the user data in the stream</p>
<p>Options:</p>
<ul><li><p>Bigint</p>
</li><li><p>Double</p>
</li><li><p>Boolean</p>
</li><li><p>Timestamp</p>
</li><li><p>String</p>
</li><li><p>Decimal</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.1 "><p>value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.19.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.19.2.4.1.3 "><p>Constant or JSON attribute name of the user data in the stream</p>
<p>Value range: 1–32. The value can contain only letters, digits, and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying Dump Task Details</p>
<pre class="screen">GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/{task_name}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Normal response</p>
<pre class="screen">{
"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" : ""
},
"partitions" : [ {
"partitionId" : "shardId-0000000000",
"discard" : 0,
"state" : "RUNNING",
"last_transfer_timestamp" : 1606984428612,
"last_transfer_offset" : 289897
} ]
}</pre>
</div>
<div class="section"><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><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Normal response</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>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