forked from docs/doc-exports
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: chenxiaoxiong <chenxiaoxiong@huawei.com> Co-committed-by: chenxiaoxiong <chenxiaoxiong@huawei.com>
373 lines
20 KiB
HTML
373 lines
20 KiB
HTML
<a name="dis_02_0410"></a><a name="dis_02_0410"></a>
|
|
|
|
<h1 class="topictitle1">Adding OBS Dump Tasks</h1>
|
|
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add OBS dump tasks.</p>
|
|
</div>
|
|
<div class="section" id="dis_02_0410__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="dis_02_0410__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p>POST /v2/{project_id}/streams/{stream_name}/transfer-tasks</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>
|
|
<p>Maximum: <strong>60</strong></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="dis_02_0410__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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0410__request_CreateTransferTaskReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p>destination_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><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>Default: <strong>NOWHERE</strong></p>
|
|
<p>Enumeration values:</p>
|
|
<ul><li><p><strong>OBS</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p>obs_destination_descriptor</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p><a href="#dis_02_0410__request_OBSDestinationDescriptorRequest">OBSDestinationDescriptorRequest</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p>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="dis_02_0410__request_OBSDestinationDescriptorRequest"></a><a name="request_OBSDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0410__request_OBSDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 4 </b>OBSDestinationDescriptorRequest</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p>task_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>agency_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>deliver_time_interval</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>consumer_strategy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>file_prefix</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>partition_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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 > 11 > 10 > 14 > 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.4.4.2.5.1.1 "><p>obs_bucket_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>destination_file_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>processing_schema</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p><a href="#dis_02_0410__request_ProcessingSchema">ProcessingSchema</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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.4.4.2.5.1.1 "><p>record_delimiter</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><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="dis_02_0410__request_ProcessingSchema"></a><a name="request_ProcessingSchema"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0410__request_ProcessingSchema" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ProcessingSchema</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p>Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p>Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p>Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p>Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p>timestamp_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p>Attribute name of the source data timestamp</p>
|
|
</td>
|
|
</tr>
|
|
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p>timestamp_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p>Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><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.4.5.2.5.1.1 "><p>timestamp_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p>No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p>String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><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>
|
|
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Requests</h4><ul><li><p>Adding OBS Dump Tasks</p>
|
|
<pre class="screen">POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
|
|
|
|
{
|
|
"destination_type" : "OBS",
|
|
"obs_destination_descriptor" : {
|
|
"task_name" : "newtask",
|
|
"consumer_strategy" : "LATEST",
|
|
"agency_name" : "dis_admin_agency",
|
|
"destination_file_type" : "text",
|
|
"obs_bucket_path" : "obsbucket",
|
|
"file_prefix" : "",
|
|
"partition_format" : "yyyy/MM/dd/HH/mm",
|
|
"record_delimiter" : "|",
|
|
"deliver_time_interval" : 30
|
|
}
|
|
}</pre>
|
|
</li><li><p>Adding OBS Dump Tasks (The dump file format is Parquet.)</p>
|
|
<pre class="screen">POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
|
|
|
|
{
|
|
"destination_type" : "OBS",
|
|
"obs_destination_descriptor" : {
|
|
"task_name" : "newtask",
|
|
"consumer_strategy" : "LATEST",
|
|
"agency_name" : "dis_admin_agency",
|
|
"destination_file_type" : "parquet",
|
|
"obs_bucket_path" : "obsbucket",
|
|
"file_prefix" : "",
|
|
"partition_format" : "yyyy/MM/dd/HH/mm",
|
|
"record_delimiter" : "|",
|
|
"deliver_time_interval" : 30
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0410__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>201</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>
|
|
|