vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dis/api-ref/CreateCloudTableTransferTask.html
gtema 6bc123a554 Reimplementation of docs/doc-exports#263 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2022-11-11 12:03:08 +00:00

686 lines
60 KiB
HTML
Raw Blame History

<a name="CreateCloudTableTransferTask"></a><a name="CreateCloudTableTransferTask"></a>
<h1 class="topictitle1">Adding CloudTable Dump Tasks</h1>
<div id="body146716247589"><div class="section" id="CreateCloudTableTransferTask__section146752419589"><h4 class="sectiontitle">Function</h4><p id="CreateCloudTableTransferTask__p1867624165811">This API is used to add CloudTable dump tasks.</p>
</div>
<div class="section" id="CreateCloudTableTransferTask__section9671624155813"><h4 class="sectiontitle">URI</h4><p id="CreateCloudTableTransferTask__p267102445819">POST /v2/{project_id}/streams/{stream_name}/transfer-tasks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__table14681724155812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row167172412581"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateCloudTableTransferTask__p1668424205813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateCloudTableTransferTask__p1868324195812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateCloudTableTransferTask__p196811247582">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateCloudTableTransferTask__p16815242588">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row56712485818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateCloudTableTransferTask__p2681024175815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateCloudTableTransferTask__p46916242581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateCloudTableTransferTask__p176942485819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1769162414582">Project ID.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row1768182495813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateCloudTableTransferTask__p169124155813">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1269102416586">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateCloudTableTransferTask__p146992445818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1169182445810">Name of the stream.</p>
<p id="CreateCloudTableTransferTask__p117052445817">Maximum: <strong id="CreateCloudTableTransferTask__b4708245589">60</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateCloudTableTransferTask__section77092419587"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row16701242588"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateCloudTableTransferTask__p1070124205817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateCloudTableTransferTask__p7705245587">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateCloudTableTransferTask__p15711524105814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateCloudTableTransferTask__p16713243586">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row470192435815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateCloudTableTransferTask__p771152415812">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateCloudTableTransferTask__p571324175817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateCloudTableTransferTask__p4716244580">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1471224155819">User token.</p>
<p id="CreateCloudTableTransferTask__p107162416583">The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_CreateCloudTableTransferTaskReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row172524125814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateCloudTableTransferTask__p137242418584">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateCloudTableTransferTask__p167219249580">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateCloudTableTransferTask__p872192412582">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateCloudTableTransferTask__p12721724135817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row1672924135816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCloudTableTransferTask__p147310243585">destination_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCloudTableTransferTask__p97322465813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCloudTableTransferTask__p4731924185810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCloudTableTransferTask__p67372418588">Dump destination. Possible values:</p>
<ul id="CreateCloudTableTransferTask__ul14732244588"><li id="CreateCloudTableTransferTask__li473162410584">OBS: Data is dumped to OBS.</li><li id="CreateCloudTableTransferTask__li1373122455814">MRS: Data is dumped to MRS.</li><li id="CreateCloudTableTransferTask__li147372475817">DLI: Data is dumped to DLI.</li><li id="CreateCloudTableTransferTask__li973424175816">CLOUDTABLE: Data is dumped to CloudTable.</li><li id="CreateCloudTableTransferTask__li17741724135810">DWS: Data is dumped to DWS.</li></ul>
<p id="CreateCloudTableTransferTask__p20741224145813">Default: <strong id="CreateCloudTableTransferTask__b9743241588">NOWHERE</strong></p>
<p id="CreateCloudTableTransferTask__p974132416584">Enumeration values:</p>
<ul id="CreateCloudTableTransferTask__ul167417249580"><li id="CreateCloudTableTransferTask__li37418244584"><strong id="CreateCloudTableTransferTask__b1274172455818">CLOUDTABLE</strong></li></ul>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row1172122418589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1674112435812">cloudtable_destination_descriptor</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCloudTableTransferTask__p4748246585">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1874122415587"><a href="#CreateCloudTableTransferTask__request_CloudtableDestinationDescriptorRequest">CloudtableDestinationDescriptorRequest</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1775124145812">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="CreateCloudTableTransferTask__request_CloudtableDestinationDescriptorRequest"></a><a name="request_CloudtableDestinationDescriptorRequest"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_CloudtableDestinationDescriptorRequest" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CloudtableDestinationDescriptorRequest</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row177682410584"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateCloudTableTransferTask__p1176524105818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateCloudTableTransferTask__p97652405813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateCloudTableTransferTask__p1576112418584">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateCloudTableTransferTask__p187716245588">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row1376112418589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p277224135820">task_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1177202435816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p107715242588">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p27713243581">Name of the dump task. The task name consists of letters, digits, hyphens (-), and underscores (_). It must be a string of 1 to 64 characters.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row197632445816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p7777248581">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p377224195811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p177872445812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p127862445813">Name of the agency created on IAM. DIS uses an agency to access your specified resources. The parameters for creating an agency are as follows:</p>
<ul id="CreateCloudTableTransferTask__ul1478172414582"><li id="CreateCloudTableTransferTask__li197882410585">Agency Type: Cloud service</li><li id="CreateCloudTableTransferTask__li6781624115813">Cloud Service: DIS</li><li id="CreateCloudTableTransferTask__li778152475819">Validity Period: unlimited</li><li id="CreateCloudTableTransferTask__li278172475819">Scope: Global service, Project: OBS. Select the Tenant Administrator role for the global service project.</li></ul>
<p id="CreateCloudTableTransferTask__p1978224115817">If agencies have been created, you can obtain available agencies from the agency list by using the "Listing Agencies " API.</p>
<p id="CreateCloudTableTransferTask__p17932485815">This parameter cannot be left blank and the parameter value cannot exceed 64 characters.</p>
<p id="CreateCloudTableTransferTask__p17798240584">If there are dump tasks on the console, the system displays a message indicating that an agency will be automatically created. The name of the automatically created agency is dis_admin_agency.</p>
<p id="CreateCloudTableTransferTask__p87912411589">Maximum: <strong id="CreateCloudTableTransferTask__b07942435817">64</strong></p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row176182425819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p167917243588">deliver_time_interval</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p0795243589">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p879162425810">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p178012415588">User-defined interval at which data is imported from the current DIS stream into OBS. If no data is pushed to the DIS stream during the current interval, no dump file package will be generated.</p>
<p id="CreateCloudTableTransferTask__p188072425818">Value range: 30-900</p>
<p id="CreateCloudTableTransferTask__p16801424145813">Default value: 300</p>
<p id="CreateCloudTableTransferTask__p20801324205811">Unit: second</p>
<p id="CreateCloudTableTransferTask__p118016243585">Minimum: <strong id="CreateCloudTableTransferTask__b188052455819">30</strong></p>
<p id="CreateCloudTableTransferTask__p5809248586">Maximum: <strong id="CreateCloudTableTransferTask__b18801024165812">900</strong></p>
<p id="CreateCloudTableTransferTask__p6801249586">Default: <strong id="CreateCloudTableTransferTask__b1380102418581">300</strong></p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row47692414581"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p18801324175817">consumer_strategy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p158012445815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1781112417589">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p16811024115816">Offset.</p>
<ul id="CreateCloudTableTransferTask__ul081102445811"><li id="CreateCloudTableTransferTask__li3811724175810">LATEST: Maximum offset, indicating that the latest data will be extracted.</li><li id="CreateCloudTableTransferTask__li1281102413587">TRIM_HORIZON: Minimum offset, indicating that the earliest data will be extracted.</li></ul>
<p id="CreateCloudTableTransferTask__p8810245582">Default value: LATEST</p>
<p id="CreateCloudTableTransferTask__p281524125814">Default: <strong id="CreateCloudTableTransferTask__b98142455812">LATEST</strong></p>
<p id="CreateCloudTableTransferTask__p88192417586">Enumeration values:</p>
<ul id="CreateCloudTableTransferTask__ul1812247581"><li id="CreateCloudTableTransferTask__li1781202413584"><strong id="CreateCloudTableTransferTask__b2082324185810">LATEST</strong></li><li id="CreateCloudTableTransferTask__li1082122495811"><strong id="CreateCloudTableTransferTask__b138252416587">TRIM_HORIZON</strong></li></ul>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row187682413586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p188222445810">cloudtable_cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p7821224135814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p58232415586">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1282142485818">Name of the CloudTable cluster to which data will be dumped.</p>
<p id="CreateCloudTableTransferTask__p18821024165810">If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row10761124145810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p98232412580">cloudtable_cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1783724205814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p583524125817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p158362455812">ID of the CloudTable cluster to which data will be dumped.</p>
<p id="CreateCloudTableTransferTask__p883124155815">If you choose to dump data to OpenTSDB, OpenTSDB must be enabled for the cluster.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row1276192455814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p14833249583">cloudtable_table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p683724195815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p5831924125811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p08315245582">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 id="CreateCloudTableTransferTask__row7761724165813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p08482410582">cloudtable_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p48414241581">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p118419243584"><a href="#CreateCloudTableTransferTask__request_CloudtableSchema">CloudtableSchema</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p9841624105814">Schema configuration of the CloudTable HBase data. You can set either this parameter or opentsdb_schema, 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 id="CreateCloudTableTransferTask__row14761824205812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p28442435810">opentsdb_schema</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1848246588">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p128517249586">Array of <a href="#CreateCloudTableTransferTask__request_OpenTSDBSchema">OpenTSDBSchema</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p58532410584">Schema configuration of the CloudTable OpenTSDB data. You can set either this parameter or opentsdb_schema, 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 id="CreateCloudTableTransferTask__row176152416588"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p585152415582">cloudtable_row_key_delimiter</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1785142417581">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p19851824105813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p78512241580">Delimiter used to separate the user data that generates HBase row keys. Value range: , . | ; \ - _ and ~</p>
<p id="CreateCloudTableTransferTask__p28522419583">Default value: .</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row17618248589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p58611240582">obs_backup_bucket_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p2086524205811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p10861724185813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p0862241580">Name of the OBS bucket used to back up data that failed to be dumped to CloudTable.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row207642413587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p98612247585">backup_file_prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p118612411582">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p188632495818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p186102415819">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.</p>
<p id="CreateCloudTableTransferTask__p148732495818">Value range: a string of letters, digits, and underscores (_)</p>
<p id="CreateCloudTableTransferTask__p387182410585">The maximum length is 50 characters.</p>
<p id="CreateCloudTableTransferTask__p28715242584">This parameter is left empty by default.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row87642415586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1287192412587">retry_duration</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCloudTableTransferTask__p13871124165812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCloudTableTransferTask__p687162495818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1287324145811">Time duration for DIS to retry if data fails to be dumped to CloudTable. If this threshold is exceeded, the data that fails to be dumped will be backed up to the OBS bucket/backup_file_prefix /cloudtable_error or OBS bucket/backup_file_prefix/opentsdb_error directory.</p>
<p id="CreateCloudTableTransferTask__p887152445813">Value range: 0-7,200</p>
<p id="CreateCloudTableTransferTask__p58702445817">Unit: second</p>
<p id="CreateCloudTableTransferTask__p1988122418586">Default value: 1,800</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_CloudtableSchema"></a><a name="request_CloudtableSchema"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_CloudtableSchema" frame="border" border="1" rules="all"><caption><b>Table 5 </b>CloudtableSchema</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row48818245586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="CreateCloudTableTransferTask__p1588824135813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="CreateCloudTableTransferTask__p18881624185815">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="CreateCloudTableTransferTask__p98811248581">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="CreateCloudTableTransferTask__p1389122413582">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row3881324165811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateCloudTableTransferTask__p168932455817">row_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateCloudTableTransferTask__p38902411587">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateCloudTableTransferTask__p11891924195818">Array of <a href="#CreateCloudTableTransferTask__request_RowKey">RowKey</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateCloudTableTransferTask__p17891624145812">HBase rowkey schema used by the CloudTable cluster to convert JSON data into HBase rowkeys.</p>
<p id="CreateCloudTableTransferTask__p98913248585">Value range: 1-64</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row888424165815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateCloudTableTransferTask__p128932485811">columns</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateCloudTableTransferTask__p179014248582">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateCloudTableTransferTask__p199072420587">Array of <a href="#CreateCloudTableTransferTask__request_Column">Column</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateCloudTableTransferTask__p9901324175816">HBase column schema used by the CloudTable cluster to convert JSON data into HBase columns.</p>
<p id="CreateCloudTableTransferTask__p1190142455810">Value range: 1 to 4,096</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_RowKey"></a><a name="request_RowKey"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_RowKey" frame="border" border="1" rules="all"><caption><b>Table 6 </b>RowKey</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row159019242582"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="CreateCloudTableTransferTask__p3919243584">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="CreateCloudTableTransferTask__p1691324155812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="CreateCloudTableTransferTask__p1092172455813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="CreateCloudTableTransferTask__p149210242581">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row290162417587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateCloudTableTransferTask__p199282412583">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateCloudTableTransferTask__p16921524145816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateCloudTableTransferTask__p199213249585">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1292152417585">JSON attribute name, which is used to generate HBase rowkeys for JSON data in the DIS stream.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row1990102455816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1921324185818">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateCloudTableTransferTask__p149372416585">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateCloudTableTransferTask__p169312243587">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateCloudTableTransferTask__p19314245581">JSON attribute type of JSON data in the DIS stream. Value range:</p>
<ul id="CreateCloudTableTransferTask__ul1293192412588"><li id="CreateCloudTableTransferTask__li1293182445813">Bigint</li><li id="CreateCloudTableTransferTask__li129319248584">Double</li><li id="CreateCloudTableTransferTask__li119392419588">Boolean</li><li id="CreateCloudTableTransferTask__li12936242584">Timestamp</li><li id="CreateCloudTableTransferTask__li59422410580">String</li><li id="CreateCloudTableTransferTask__li129452445813">Decimal</li></ul>
<p id="CreateCloudTableTransferTask__p49402411582">Enumeration values:</p>
<ul id="CreateCloudTableTransferTask__ul129422495812"><li id="CreateCloudTableTransferTask__li18941824135812"><strong id="CreateCloudTableTransferTask__b79462414582">Bigint</strong></li><li id="CreateCloudTableTransferTask__li394142419589"><strong id="CreateCloudTableTransferTask__b1294124185810">Double</strong></li><li id="CreateCloudTableTransferTask__li89452416585"><strong id="CreateCloudTableTransferTask__b794152415581">Boolean</strong></li><li id="CreateCloudTableTransferTask__li169442412585"><strong id="CreateCloudTableTransferTask__b394132415582">Timestamp</strong></li><li id="CreateCloudTableTransferTask__li19947248586"><strong id="CreateCloudTableTransferTask__b109411245581">String</strong></li><li id="CreateCloudTableTransferTask__li3951524125812"><strong id="CreateCloudTableTransferTask__b129562411588">Decimal</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_Column"></a><a name="request_Column"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_Column" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Column</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row295202413586"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="CreateCloudTableTransferTask__p095102475812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="CreateCloudTableTransferTask__p2951524185820">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="CreateCloudTableTransferTask__p196524135816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="CreateCloudTableTransferTask__p396824125815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row895112413586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="CreateCloudTableTransferTask__p17966248586">column_family_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="CreateCloudTableTransferTask__p7961024175816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="CreateCloudTableTransferTask__p109682475815">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1596724185814">Name of the HBase column family to which data will be dumped.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row8951224185813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1897224165818">column_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="CreateCloudTableTransferTask__p6971424125818">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="CreateCloudTableTransferTask__p39716246582">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="CreateCloudTableTransferTask__p12971424145818">Name of the HBase column to which data will be dumped.</p>
<p id="CreateCloudTableTransferTask__p99719242586">Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row1395112495816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1819972416582">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="CreateCloudTableTransferTask__p11199162412584">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="CreateCloudTableTransferTask__p519942445816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1819962412586">JSON attribute name, which is used to generate HBase column values for JSON data in the DIS stream.</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row495202418583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="CreateCloudTableTransferTask__p9199182415819">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="CreateCloudTableTransferTask__p619922445815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="CreateCloudTableTransferTask__p171991424115817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="CreateCloudTableTransferTask__p191991224145816">JSON attribute type of JSON data in the DIS stream.</p>
<p id="CreateCloudTableTransferTask__p41999244584">Value range:</p>
<ul id="CreateCloudTableTransferTask__ul9199424135813"><li id="CreateCloudTableTransferTask__li1019922495820">Bigint</li><li id="CreateCloudTableTransferTask__li1199924155818">Double</li><li id="CreateCloudTableTransferTask__li121991824185816">Boolean</li><li id="CreateCloudTableTransferTask__li5199112495813">Timestamp</li><li id="CreateCloudTableTransferTask__li141991224185810">String</li><li id="CreateCloudTableTransferTask__li1219982445820">Decimal</li></ul>
<p id="CreateCloudTableTransferTask__p71999240583">Enumeration values:</p>
<ul id="CreateCloudTableTransferTask__ul1219916246583"><li id="CreateCloudTableTransferTask__li61991824165816"><strong id="CreateCloudTableTransferTask__b17200142413588">Bigint</strong></li><li id="CreateCloudTableTransferTask__li10200524145818"><strong id="CreateCloudTableTransferTask__b11200132425814">Double</strong></li><li id="CreateCloudTableTransferTask__li182001824145815"><strong id="CreateCloudTableTransferTask__b420010246585">Boolean</strong></li><li id="CreateCloudTableTransferTask__li7200192410587"><strong id="CreateCloudTableTransferTask__b5200142495814">Timestamp</strong></li><li id="CreateCloudTableTransferTask__li2200152435815"><strong id="CreateCloudTableTransferTask__b1320052475815">String</strong></li><li id="CreateCloudTableTransferTask__li1200024145812"><strong id="CreateCloudTableTransferTask__b320013245582">Decimal</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_OpenTSDBSchema"></a><a name="request_OpenTSDBSchema"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_OpenTSDBSchema" frame="border" border="1" rules="all"><caption><b>Table 8 </b>OpenTSDBSchema</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row9100122475814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.1"><p id="CreateCloudTableTransferTask__p720011242588">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.2"><p id="CreateCloudTableTransferTask__p15200172475816">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.3"><p id="CreateCloudTableTransferTask__p42001024185820">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.8.2.5.1.4"><p id="CreateCloudTableTransferTask__p11200142445811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row510022415815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="CreateCloudTableTransferTask__p14200124135820">metric</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="CreateCloudTableTransferTask__p32001424155819">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="CreateCloudTableTransferTask__p2200824155812">Array of <a href="#CreateCloudTableTransferTask__request_OpenTSDBMetric">OpenTSDBMetric</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="CreateCloudTableTransferTask__p22006244586">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 id="CreateCloudTableTransferTask__row51003249589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1220172405817">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1120112418584">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1720122414589"><a href="#CreateCloudTableTransferTask__request_OpenTSDBTimestamp">OpenTSDBTimestamp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="CreateCloudTableTransferTask__p82013244587">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 id="CreateCloudTableTransferTask__row11001524195817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="CreateCloudTableTransferTask__p12201824105814">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="CreateCloudTableTransferTask__p182015249587">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="CreateCloudTableTransferTask__p102012024195814"><a href="#CreateCloudTableTransferTask__request_OpenTSDBValue">OpenTSDBValue</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="CreateCloudTableTransferTask__p162011724105812">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 id="CreateCloudTableTransferTask__row11000240589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="CreateCloudTableTransferTask__p420116240588">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1620132475817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="CreateCloudTableTransferTask__p142011424185814">Array of <a href="#CreateCloudTableTransferTask__request_OpenTSDBTags">OpenTSDBTags</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="CreateCloudTableTransferTask__p10201102414584">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="CreateCloudTableTransferTask__request_OpenTSDBMetric"></a><a name="request_OpenTSDBMetric"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_OpenTSDBMetric" frame="border" border="1" rules="all"><caption><b>Table 9 </b>OpenTSDBMetric</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row51035246588"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.1"><p id="CreateCloudTableTransferTask__p2020152435812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.2"><p id="CreateCloudTableTransferTask__p1201224125820">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.3"><p id="CreateCloudTableTransferTask__p162018243588">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.9.2.5.1.4"><p id="CreateCloudTableTransferTask__p172011124155818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row1310322495816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.1 "><p id="CreateCloudTableTransferTask__p11201924145820">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1820122413581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.3 "><p id="CreateCloudTableTransferTask__p17201124175810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.9.2.5.1.4 "><ul id="CreateCloudTableTransferTask__ul11201124195814"><li id="CreateCloudTableTransferTask__li520192465815">When type is set to Constant, the value of metric is the value of Value.</li><li id="CreateCloudTableTransferTask__li172011024115812">When value is set to String, the value of metric is the value of the JSON attribute of the user data in the stream.</li></ul>
<p id="CreateCloudTableTransferTask__p1620120248581">Enumeration values:</p>
<ul id="CreateCloudTableTransferTask__ul142014242586"><li id="CreateCloudTableTransferTask__li220142425812"><strong id="CreateCloudTableTransferTask__b1201224155814">Constant</strong></li><li id="CreateCloudTableTransferTask__li7201102415584"><strong id="CreateCloudTableTransferTask__b1220232455815">String</strong></li></ul>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row14103162417582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.1 "><p id="CreateCloudTableTransferTask__p15202224115815">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.2 "><p id="CreateCloudTableTransferTask__p720214248587">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.3 "><p id="CreateCloudTableTransferTask__p820292405819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.9.2.5.1.4 "><p id="CreateCloudTableTransferTask__p0202024195815">Constant value or JSON attribute name of the user data in the stream. This value is 1 to 32 characters long. Only letters, digits, and periods (.) are allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_OpenTSDBTimestamp"></a><a name="request_OpenTSDBTimestamp"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_OpenTSDBTimestamp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>OpenTSDBTimestamp</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row15105102445814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.1"><p id="CreateCloudTableTransferTask__p1020210244582">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.2"><p id="CreateCloudTableTransferTask__p420222475820">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.3"><p id="CreateCloudTableTransferTask__p14202424155815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.10.2.5.1.4"><p id="CreateCloudTableTransferTask__p172022024105813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row11105624175820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.1 "><p id="CreateCloudTableTransferTask__p120232413580">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1420282410581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1520213242588">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.10.2.5.1.4 "><ul id="CreateCloudTableTransferTask__ul5202124145818"><li id="CreateCloudTableTransferTask__li6202132419585">When type is set to Timestamp, the value type of the JSON attribute of the user data in the stream is Timestamp, and the timestamp of OpenTSDB can be generated without converting the data format.</li><li id="CreateCloudTableTransferTask__li7202924195814">When type is set to String, the value type of the JSON attribute of the user data in the stream is Date, and the timestamp of OpenTSDB can be generated only after the data format is converted.</li></ul>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row1310642418582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.1 "><p id="CreateCloudTableTransferTask__p182021924145812">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.2 "><p id="CreateCloudTableTransferTask__p620272413582">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1220222425819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.10.2.5.1.4 "><p id="CreateCloudTableTransferTask__p620222410586">JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row101062248580"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1320212495817">format</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.2 "><p id="CreateCloudTableTransferTask__p220211241582">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.3 "><p id="CreateCloudTableTransferTask__p120217244586">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.10.2.5.1.4 "><p id="CreateCloudTableTransferTask__p12202102413587">This parameter is mandatory when type is set to String. When the value type of the JSON attribute of the user data in the stream is Date, format is required to convert the data format to generate the timestamp of OpenTSDB.</p>
<p id="CreateCloudTableTransferTask__p92024245587">Value range:</p>
<ul id="CreateCloudTableTransferTask__ul9202202465813"><li id="CreateCloudTableTransferTask__li4202162465810">yyyy/MM/dd HH:mm:ss</li><li id="CreateCloudTableTransferTask__li192027243584">MM/dd/yyyy HH:mm:ss</li><li id="CreateCloudTableTransferTask__li172021724175815">dd/MM/yyyy HH:mm:ss</li><li id="CreateCloudTableTransferTask__li1320252415814">yyyy-MM-dd HH:mm:ss</li><li id="CreateCloudTableTransferTask__li162031924145810">MM-dd-yyyy HH:mm:ss</li><li id="CreateCloudTableTransferTask__li1720312245580">dd-MM-yyyy HH:mm:ss</li></ul>
<p id="CreateCloudTableTransferTask__p17203182411587">Enumeration values:</p>
<ul id="CreateCloudTableTransferTask__ul1420362455817"><li id="CreateCloudTableTransferTask__li19203624155816"><strong id="CreateCloudTableTransferTask__b120372485812">yyyy/MM/dd HH:mm:ss</strong></li><li id="CreateCloudTableTransferTask__li15203162412580"><strong id="CreateCloudTableTransferTask__b12203162419584">MM/dd/yyyy HH:mm:ss</strong></li><li id="CreateCloudTableTransferTask__li120322475810"><strong id="CreateCloudTableTransferTask__b1820312415811">dd/MM/yyyy HH:mm:ss</strong></li><li id="CreateCloudTableTransferTask__li8203142415814"><strong id="CreateCloudTableTransferTask__b520392435815">yyyy-MM-dd HH:mm:ss</strong></li><li id="CreateCloudTableTransferTask__li7203152445810"><strong id="CreateCloudTableTransferTask__b132034248584">MM-dd-yyyy HH:mm:ss</strong></li><li id="CreateCloudTableTransferTask__li1220315248582"><strong id="CreateCloudTableTransferTask__b6203112413587">dd-MM-yyyy HH:mm:ss</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_OpenTSDBValue"></a><a name="request_OpenTSDBValue"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_OpenTSDBValue" frame="border" border="1" rules="all"><caption><b>Table 11 </b>OpenTSDBValue</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row17109172419587"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.1"><p id="CreateCloudTableTransferTask__p14203162419588">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.2"><p id="CreateCloudTableTransferTask__p1720319242586">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.3"><p id="CreateCloudTableTransferTask__p32031724105813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.11.2.5.1.4"><p id="CreateCloudTableTransferTask__p12203102420586">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row1110916246580"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="CreateCloudTableTransferTask__p120320245586">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1620372415588">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1203524175812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.11.2.5.1.4 "><p id="CreateCloudTableTransferTask__p10203162415587">Dump destination. Possible values: Value range:</p>
<ul id="CreateCloudTableTransferTask__ul1020310247584"><li id="CreateCloudTableTransferTask__li13203102405812">Bigint</li><li id="CreateCloudTableTransferTask__li1820362435817">Double</li><li id="CreateCloudTableTransferTask__li32033242585">Boolean</li><li id="CreateCloudTableTransferTask__li1820362419588">Timestamp</li><li id="CreateCloudTableTransferTask__li10203192455811">String</li><li id="CreateCloudTableTransferTask__li5203132417586">Decimal</li></ul>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row16110824135819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1520482415813">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.2 "><p id="CreateCloudTableTransferTask__p17204924155813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="CreateCloudTableTransferTask__p920416241588">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.11.2.5.1.4 "><p id="CreateCloudTableTransferTask__p19204162412583">Constant value or JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateCloudTableTransferTask__request_OpenTSDBTags"></a><a name="request_OpenTSDBTags"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__request_OpenTSDBTags" frame="border" border="1" rules="all"><caption><b>Table 12 </b>OpenTSDBTags</caption><thead align="left"><tr id="CreateCloudTableTransferTask__row15112162475811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.1"><p id="CreateCloudTableTransferTask__p42041524185813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.2"><p id="CreateCloudTableTransferTask__p520452485812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.3"><p id="CreateCloudTableTransferTask__p120402411582">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.12.2.5.1.4"><p id="CreateCloudTableTransferTask__p142041924195810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row1211262412587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1720412246584">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.2 "><p id="CreateCloudTableTransferTask__p1220422418580">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="CreateCloudTableTransferTask__p1320419245580">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.12.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1620422413582">Tag name of the OpenTSDB data that stores the data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)</p>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row8112192425819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1220442405819">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.2 "><p id="CreateCloudTableTransferTask__p18204824135818">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="CreateCloudTableTransferTask__p12204142425819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.12.2.5.1.4 "><p id="CreateCloudTableTransferTask__p1120462418583">Type name of the JSON attribute of the user data in the stream.</p>
<p id="CreateCloudTableTransferTask__p102044242584">Value range:</p>
<ul id="CreateCloudTableTransferTask__ul5204124145811"><li id="CreateCloudTableTransferTask__li5204152445815">Bigint</li><li id="CreateCloudTableTransferTask__li17204024195817">Double</li><li id="CreateCloudTableTransferTask__li1120419246580">Boolean</li><li id="CreateCloudTableTransferTask__li1220432414587">Timestamp</li><li id="CreateCloudTableTransferTask__li6204224115811">String</li><li id="CreateCloudTableTransferTask__li320452419584">Decimal</li></ul>
</td>
</tr>
<tr id="CreateCloudTableTransferTask__row311262417585"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="CreateCloudTableTransferTask__p1220432425818">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.2 "><p id="CreateCloudTableTransferTask__p14204424205812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="CreateCloudTableTransferTask__p9204182485812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.12.2.5.1.4 "><p id="CreateCloudTableTransferTask__p2204102465811">Constant value or JSON attribute name of the user data in the stream. Value range: a string of 1 to 32 characters, consisting of only letters, digits, and underscores (_)</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateCloudTableTransferTask__section52051024105818"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateCloudTableTransferTask__p1205172414585">None</p>
</div>
<div class="section" id="CreateCloudTableTransferTask__section13205162465813"><h4 class="sectiontitle">Example Requests</h4><ul id="CreateCloudTableTransferTask__ul620511246580"><li id="CreateCloudTableTransferTask__li1620582420584">Adding CloudTable HBase Dump Tasks<pre class="screen" id="CreateCloudTableTransferTask__screen820518243580">POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
{
"destination_type" : "CLOUDTABLE",
"cloudtable_destination_descriptor" : {
"task_name" : "hbasetask",
"consumer_strategy" : "TRIM_HORIZON",
"agency_name" : "dis_admin_agency",
"cloudtable_cluster_name" : "cloudtablecluster",
"cloudtable_cluster_id" : "b8c095e2-db5f-4732-8a1d-eacd662e35dc",
"cloudtable_table_name" : "cloudtabletable",
"cloudtable_row_key_delimiter" : "|",
"retry_duration" : 1800,
"obs_backup_bucket_path" : "obsbackupbucket",
"backup_file_prefix" : "",
"cloudtable_schema" : {
"row_key" : [ {
"value" : "datavalue",
"type" : "String"
} ],
"columns" : [ {
"column_family_name" : "cfname1",
"column_name" : "ID",
"value" : "datavalue1",
"type" : "String"
}, {
"column_family_name" : "cfname2",
"column_name" : "VALUE",
"value" : "datavalue2",
"type" : "String"
} ]
}
}
}</pre>
</li><li id="CreateCloudTableTransferTask__li20206192465814">Adding CloudTable OpenTSDB Dump Tasks<pre class="screen" id="CreateCloudTableTransferTask__screen152061824165815">POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks
{
"destination_type" : "CLOUDTABLE",
"cloudtable_destination_descriptor" : {
"task_name" : "opentsdbtask",
"consumer_strategy" : "LATEST",
"agency_name" : "dis_admin_agency",
"cloudtable_cluster_name" : "cloudtablecluster",
"cloudtable_cluster_id" : "b8c095e2-db5f-4732-8a1d-eacd662e35dc",
"retry_duration" : 1800,
"obs_backup_bucket_path" : "obsbackupbucket",
"backup_file_prefix" : "",
"opentsdb_schema" : [ {
"metric" : [ {
"type" : "Constant",
"value" : "age"
} ],
"timestamp" : {
"value" : "date",
"type" : "String",
"format" : "yyyy/MM/dd HH:mm:ss"
},
"value" : {
"value" : "value",
"type" : "Bigint"
},
"tags" : [ {
"name" : "name",
"value" : "name",
"type" : "Bigint"
} ]
} ]
}
}</pre>
</li></ul>
</div>
<div class="section" id="CreateCloudTableTransferTask__section520792418588"><h4 class="sectiontitle">Example Responses</h4><p id="CreateCloudTableTransferTask__p1020732419581">None</p>
</div>
<div class="section" id="CreateCloudTableTransferTask__section11207192485812"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCloudTableTransferTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateCloudTableTransferTask__row1012062405817"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateCloudTableTransferTask__p112072024165813">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateCloudTableTransferTask__p202070241588">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateCloudTableTransferTask__row1112012415580"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCloudTableTransferTask__p220752410583">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCloudTableTransferTask__p6207152475813">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateCloudTableTransferTask__section19207182416587"><h4 class="sectiontitle">Error Codes</h4><p id="CreateCloudTableTransferTask__p152075244587">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