forked from docs/doc-exports
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
662 lines
63 KiB
HTML
662 lines
63 KiB
HTML
<a name="lts_api_0031"></a><a name="lts_api_0031"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Log Transfer Task</h1>
|
|
<div id="body32001227"><div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section1550215237334"><h4 class="sectiontitle">Function</h4><p id="lts_api_0031__en-us_topic_0000001217316909_p726042533314">This API is used to update an OBS transfer task.</p>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section18509192313312"><h4 class="sectiontitle">URI</h4><p id="lts_api_0031__en-us_topic_0000001217316909_p1026092516332">PUT /v2/{project_id}/transfers</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table1851422319336" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row1126032510333"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p6260112533313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p4260172515336">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p20260132518333">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="lts_api_0031__en-us_topic_0000001217316909_p2260725163311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row326042583316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p172601125163311">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p182601125143310">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p7260192593316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p142601625143316">Project ID. For details about how to obtain a project ID, see <a href="lts_api_0006.html#lts_api_0006">Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID</a>.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1026018257333">Minimum length: 32 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p13260142513333">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section95771423173316"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table145861523143317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row1126182516330"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p226112253335">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p10261182520336">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p42611725203312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="lts_api_0031__en-us_topic_0000001217316909_p226116258339">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row1926162563316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1126182515330">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p12612252331">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1026118250333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1926142583316">User token obtained from IAM.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p182616259337">Minimum length: 1000 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p182611825173311">Maximum length: 2000 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row18261925103313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1726110259330">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p62611525153311">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p7261152519335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1426132563311">Set this parameter to <strong id="lts_api_0031__en-us_topic_0000001217316909_b113519051310">application/json;charset=UTF-8</strong>.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1326162593320">Minimum length: <strong id="lts_api_0031__en-us_topic_0000001217316909_b19790165121314">30</strong> characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p182611253337">Maximum length: <strong id="lts_api_0031__en-us_topic_0000001217316909_b2033731218139">30</strong> characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table3681112318335" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row172618258337"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p152611125103319">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p2261525123310">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p182618257337">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="lts_api_0031__en-us_topic_0000001217316909_p92611257338">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row1261132593311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p142611425183319">log_transfer_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p826152523319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p112611825123315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p16261425183310">Log transfer task ID.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p12261925153313">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p2261142583310">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row152611025183319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1261192583314">log_transfer_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p152613254338">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p192611225143311"><a href="#lts_api_0031__en-us_topic_0000001217316909_table9727112314332">Table 4</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p192611725193318">Log transfer information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0031__en-us_topic_0000001217316909_table9727112314332"></a><a name="en-us_topic_0000001217316909_table9727112314332"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table9727112314332" frame="border" border="1" rules="all"><caption><b>Table 4 </b>log_transfer_info</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row4261172563317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p1226172511339">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p4261825153313">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p9261142553310">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="lts_api_0031__en-us_topic_0000001217316909_p326282523312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row1926216250332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p6262192553315">log_storage_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p142624259331">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p3262202563317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p152629250335">Log transfer format. The value can be <strong id="lts_api_0031__en-us_topic_0000001217316909_b18136185494353">RAW</strong> or <strong id="lts_api_0031__en-us_topic_0000001217316909_b116739032994353">JSON</strong>. <strong id="lts_api_0031__en-us_topic_0000001217316909_b80166755794353">RAW</strong> indicates raw log format, whereas <strong id="lts_api_0031__en-us_topic_0000001217316909_b192436907894353">JSON</strong> indicates JSON format. <strong id="lts_api_0031__en-us_topic_0000001217316909_b174359019994353">JSON</strong> and <strong id="lts_api_0031__en-us_topic_0000001217316909_b199175373694353">RAW</strong> are supported for OBS and DIS transfer tasks, but only <strong id="lts_api_0031__en-us_topic_0000001217316909_b1682890394353">RAW</strong> is supported for DMS transfer tasks.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p72622256332">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul142621625123311"><li id="lts_api_0031__en-us_topic_0000001217316909_li13262725153315"><strong id="lts_api_0031__en-us_topic_0000001217316909_b6262152543315">JSON</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li426214256332"><strong id="lts_api_0031__en-us_topic_0000001217316909_b1826212519330">RAW</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1826282517337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1426218251330">log_transfer_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p02621625113317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p6262192511336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1326212512335">Log transfer status. <strong id="lts_api_0031__en-us_topic_0000001217316909_b87994388494353">ENABLE</strong> indicates that log transfer is enabled, <strong id="lts_api_0031__en-us_topic_0000001217316909_b163649551494353">DISABLE</strong> indicates that log transfer is disabled, and <strong id="lts_api_0031__en-us_topic_0000001217316909_b191886396894353">EXCEPTION</strong> indicates that log transfer is abnormal.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p192624252336">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul82625253334"><li id="lts_api_0031__en-us_topic_0000001217316909_li202621925193317"><strong id="lts_api_0031__en-us_topic_0000001217316909_b13262192573319">ENABLE</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li202622257332"><strong id="lts_api_0031__en-us_topic_0000001217316909_b5262425173317">DISABLE</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li152623258337"><strong id="lts_api_0031__en-us_topic_0000001217316909_b17262102518339">EXCEPTION</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1526292510333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p132621425183310">log_transfer_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p32621125133312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1126292593319"><a href="#lts_api_0031__en-us_topic_0000001217316909_table58071921155313">Table 5</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1626272511331">Log transfer details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0031__en-us_topic_0000001217316909_table58071921155313"></a><a name="en-us_topic_0000001217316909_table58071921155313"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table58071921155313" frame="border" border="1" rules="all"><caption><b>Table 5 </b>log_transfer_detail</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row4991421125310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p99911821175317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p189912211532">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p299119218539">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="lts_api_0031__en-us_topic_0000001217316909_p79911721185319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row1699182125313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p20991102135310">obs_period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p179917211531">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p19921321175316">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p139921921135311">Length of the transfer interval for an OBS transfer task. This parameter is required to update an OBS transfer task. The log transfer interval is specified by the combination of the values of <strong id="lts_api_0031__en-us_topic_0000001217316909_b52911320310">obs_period</strong> and <strong id="lts_api_0031__en-us_topic_0000001217316909_b529153333">obs_period_unit</strong>, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1199232105314">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul129929212532"><li id="lts_api_0031__en-us_topic_0000001217316909_li699222175313"><strong id="lts_api_0031__en-us_topic_0000001217316909_b13992121155313">1</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li2992102155311"><strong id="lts_api_0031__en-us_topic_0000001217316909_b799242118535">2</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li599242117537"><strong id="lts_api_0031__en-us_topic_0000001217316909_b14992132145314">3</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li699252117532"><strong id="lts_api_0031__en-us_topic_0000001217316909_b159925210539">5</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li1599242118537"><strong id="lts_api_0031__en-us_topic_0000001217316909_b1999242116531">6</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li49921021105314"><strong id="lts_api_0031__en-us_topic_0000001217316909_b13992192114530">12</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li599292120537"><strong id="lts_api_0031__en-us_topic_0000001217316909_b16992421105318">30</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1399217211532"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5992162111539">obs_period_unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p13992192145313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p599262119532"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p4992122119538">Unit of the transfer interval for an OBS transfer task. This parameter is required to update an OBS transfer task. The log transfer interval is specified by the combination of the values of <strong id="lts_api_0031__en-us_topic_0000001217316909_b11473421831">obs_period</strong> and <strong id="lts_api_0031__en-us_topic_0000001217316909_b14741621439">obs_period_unit</strong>, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p15992102113538">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul79929212535"><li id="lts_api_0031__en-us_topic_0000001217316909_li109921421195312"><strong id="lts_api_0031__en-us_topic_0000001217316909_b129929216531">min</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li599212216535"><strong id="lts_api_0031__en-us_topic_0000001217316909_b6992172111537">hour</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1199272125320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p79925216530">obs_bucket_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p69926216538">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p29921021115313"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p79921210538">OBS bucket name. This parameter is required to update an OBS transfer task.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p599212165312">Minimum length: 3 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p19921821115316">Maximum length: 63 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row79921821155312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p29921921115318">obs_encrypted_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p8992172112539">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p119920216537"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p8993112112531">KMS key ID for an OBS transfer task. This parameter is required if encryption is enabled for the target OBS bucket.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p099332117532">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p299342114537">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row17993102115317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p20993122165311">obs_dir_pre_fix_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5993132113536">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1399362118531"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p4993421155310">Custom transfer path of an OBS transfer task. This parameter is optional.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p5993172145315">The value must match the regular expression:</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p10993112118537">^(/)?([a-zA-Z0-9\._-]+)(/[a-zA-Z0-9\._-]+)*(/)?$</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p399313218532">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p8993182195312">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row149931321205317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p14993121145316">obs_prefix_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p19993921205319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p499302113537"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p299342125318">Transfer file prefix of an OBS transfer task. This parameter is optional.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1199312145314">The value must match the regular expression:</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1799332135314">^[a-zA-Z0-9\._-]*$</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p499311217537">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p109931212532">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row15873131371418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5841715121417">obs_transfer_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p15149172715143">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p0841115111415">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p17841915131411">OBS bucket path, which is the log transfer destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1947719497148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p14224195141416">obs_eps_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p4225951191416">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p746935841411">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p0225175121420">Enterprise project ID of an OBS transfer task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row19586217154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p16652823171518">obs_encrypted_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1465214237154">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1137012307159">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p9652122318157">Whether OBS bucket encryption is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row34736165112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p145475371299">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p35471837182919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p195471937152916">Array< String ></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1922511663219">If tag delivery is enabled, this field must contain the following host information: <strong id="lts_api_0031__en-us_topic_0000001217316909_b1690113335911">hostIP</strong>, <strong id="lts_api_0031__en-us_topic_0000001217316909_b1096064594">hostId</strong>, <strong id="lts_api_0031__en-us_topic_0000001217316909_b5382207125918">hostName</strong>, <strong id="lts_api_0031__en-us_topic_0000001217316909_b475528195918">pathFile</strong>, and <strong id="lts_api_0031__en-us_topic_0000001217316909_b964299125910">collectTime</strong>.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p8287935173218">(Optional) Common fields include <strong id="lts_api_0031__en-us_topic_0000001217316909_b197421611185914">logStreamName</strong>, <strong id="lts_api_0031__en-us_topic_0000001217316909_b880151211598">regionName</strong>, <strong id="lts_api_0031__en-us_topic_0000001217316909_b15941111314594">logGroupName</strong>, and <strong id="lts_api_0031__en-us_topic_0000001217316909_b2044412155599">projectId</strong>.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1758161217304">(Optional) Enable the transfer tag: streamTag.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section208371923133318"><h4 class="sectiontitle">Response Parameters</h4><p id="lts_api_0031__en-us_topic_0000001217316909_p1249684812262"><strong id="lts_api_0031__en-us_topic_0000001217316909_b17017202538">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table18852162363317" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row82621725113320"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p92627258332">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p14262152512332">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p326272512333">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row126292519337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1926215257334">log_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p52621225183317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1826210253331">Log group ID.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p102621125193317">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p3262925163313">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row9262102543319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p6262725113314">log_group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p526210255334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p526232519331">Log group name.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p10262192517331">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1626282514339">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row172640259333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1626414251333">log_streams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p7265192503316">Array of <a href="#lts_api_0031__en-us_topic_0000001217316909_table001224193316">Table 7</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p15265172514332">Log stream list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row16265132518338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p7265102510339">log_transfer_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p626514252336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p126502523313">Log transfer task ID.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p22659252335">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p7265525103315">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row18265102518330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p16265025163310">log_transfer_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1265425143318"><a href="#lts_api_0031__en-us_topic_0000001217316909_table54017242335">Table 8</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p226532514335">Log transfer information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0031__en-us_topic_0000001217316909_table001224193316"></a><a name="en-us_topic_0000001217316909_table001224193316"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table001224193316" frame="border" border="1" rules="all"><caption><b>Table 7 </b>log_streams</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row826519254330"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p026514251339">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p72653257330">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p11265152518333">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row82658251332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p12651225153313">log_stream_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p22651025183310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1026572519338">Log stream ID.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p14265102533312">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p426514253333">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row112651125173314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p192655250333">log_stream_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p132655255333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p11265192513331">Log stream name.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p182657259332">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p182651825153318">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0031__en-us_topic_0000001217316909_table54017242335"></a><a name="en-us_topic_0000001217316909_table54017242335"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table54017242335" frame="border" border="1" rules="all"><caption><b>Table 8 </b>log_transfer_info</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row52658258332"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p926515259337">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p1726622517330">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p6266192573317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row18266132573320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p14266182519337">log_agency_transfer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p172661252336"><a href="#lts_api_0031__en-us_topic_0000001217316909_table1322072463320">Table 9</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p12661925193317">Information about delegated log transfer. This parameter is returned for a delegated log transfer task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row142664259332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p6266112523311">log_create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p226662573315">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1626619257339">Time when the log transfer task was created.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p426612563318">Minimum value: <strong id="lts_api_0031__en-us_topic_0000001217316909_b7495162695316">0</strong></p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p6266102533311">Maximum value: <strong id="lts_api_0031__en-us_topic_0000001217316909_b339814316534">9999999999999</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row526672519336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p142661825183311">log_storage_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5266925143314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5266325173315">Log transfer format. The value can be <strong id="lts_api_0031__en-us_topic_0000001217316909_b61096851994353">RAW</strong> or <strong id="lts_api_0031__en-us_topic_0000001217316909_b26081256694353">JSON</strong>. <strong id="lts_api_0031__en-us_topic_0000001217316909_b195923097794353">RAW</strong> indicates raw log format, whereas <strong id="lts_api_0031__en-us_topic_0000001217316909_b76052090294353">JSON</strong> indicates JSON format. OBS transfer tasks support <strong id="lts_api_0031__en-us_topic_0000001217316909_b95711853154">JSON</strong>.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p3266152518336">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul92661825203316"><li id="lts_api_0031__en-us_topic_0000001217316909_li1726619257339"><strong id="lts_api_0031__en-us_topic_0000001217316909_b162661125183316">JSON</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li92661253339"><strong id="lts_api_0031__en-us_topic_0000001217316909_b32661925103318">RAW</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row5266162518335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p15266172543312">log_transfer_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p326652543314">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p15266425113315">Log transfer details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1266162512331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p19266172553315">log_transfer_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p12266625103317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p122661725153318">Log transfer mode. <strong id="lts_api_0031__en-us_topic_0000001217316909_b26418034994353">cycle</strong> indicates periodical transfer, whereas <strong id="lts_api_0031__en-us_topic_0000001217316909_b171291805194353">realTime</strong> indicates real-time transfer. <strong id="lts_api_0031__en-us_topic_0000001217316909_b11935203494353">cycle</strong> is available to OBS transfer tasks and <strong id="lts_api_0031__en-us_topic_0000001217316909_b41633810194353">realTime</strong> is available to DIS and DMS transfer tasks.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1226622513333">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul1326602513315"><li id="lts_api_0031__en-us_topic_0000001217316909_li926642593311"><strong id="lts_api_0031__en-us_topic_0000001217316909_b7266225163317">cycle</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li13266122593319"><strong id="lts_api_0031__en-us_topic_0000001217316909_b726652518335">realTime</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row192661256334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p72661125103315">log_transfer_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p18267525133310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p3267225103313">Log transfer status. <strong id="lts_api_0031__en-us_topic_0000001217316909_b201063094594353">ENABLE</strong> indicates that log transfer is enabled, <strong id="lts_api_0031__en-us_topic_0000001217316909_b82170237494353">DISABLE</strong> indicates that log transfer is disabled, and <strong id="lts_api_0031__en-us_topic_0000001217316909_b108008413694353">EXCEPTION</strong> indicates that log transfer is abnormal.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1126716253331">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul726752573317"><li id="lts_api_0031__en-us_topic_0000001217316909_li1326702518337"><strong id="lts_api_0031__en-us_topic_0000001217316909_b526762543317">ENABLE</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li726732513339"><strong id="lts_api_0031__en-us_topic_0000001217316909_b8267162516333">DISABLE</strong></li><li id="lts_api_0031__en-us_topic_0000001217316909_li926712553314"><strong id="lts_api_0031__en-us_topic_0000001217316909_b102671625103315">EXCEPTION</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row5267192519339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p2267132512331">log_transfer_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p142670259336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p726718254337">Log transfer type. You can transfer logs to OBS.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p826782573316">Enumerated values:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul1626714250338"><li id="lts_api_0031__en-us_topic_0000001217316909_li72671025133315"><strong id="lts_api_0031__en-us_topic_0000001217316909_b4267112514337">OBS</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0031__en-us_topic_0000001217316909_table1322072463320"></a><a name="en-us_topic_0000001217316909_table1322072463320"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table1322072463320" frame="border" border="1" rules="all"><caption><b>Table 9 </b>log_agency_transfer</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row102671025173310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p226712553318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p326752573315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p14267525193314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row626716251338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p726712510335">agency_domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p926712511331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1267162513316">Delegator account ID.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p62677254334">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p226716251330">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row162671925113315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p526722519331">agency_domain_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p132671525163310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p826715252338">Delegator account name.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p8267162573310">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p32671259339">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row1326772563314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p626752563310">agency_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p16267325203317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1826762512330">Name of the agency created by the delegator.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p142679258337">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p10267142515339">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row182679254331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1526792583310">agency_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p026742512337">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p152671025173316">Project ID of the delegator.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p726772516336">Minimum length: 32 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p12680251330">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row3268192553320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p6268425193313">be_agency_domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p82687254336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5268182519336">Account ID of the delegated party (ID of the account that created the log transfer task).</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p142681925173313">Minimum length: 1 character</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1026842514334">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row122687251332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p18268102519337">be_agency_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5268152583314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p10268132516336">Project ID of the delegated party (project ID of the account that created the log transfer task).</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1326810259339">Minimum length: 32 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p14268192533314">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p142681725103319"><strong id="lts_api_0031__en-us_topic_0000001217316909_b14384639195313">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table331614243338" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row172681225153315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p226817252337">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p13268325173320">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p3268142519337">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row1626818253335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p32681425103315">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p4268825173315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p6268182514335">Error code.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p17268125123310">Minimum length: 8 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p162681125163320">Maximum length: 8 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row626842523312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p8268122553317">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p5268325113310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1526820253332">Error message.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p5268132593313">Enumerated value:</p>
|
|
<ul id="lts_api_0031__en-us_topic_0000001217316909_ul20268192519330"><li id="lts_api_0031__en-us_topic_0000001217316909_li182681825173310"><strong id="lts_api_0031__en-us_topic_0000001217316909_b1323193592514">Invalid projectId</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1284713325916"><strong id="lts_api_0031__en-us_topic_0000001217316909_b1980784295315">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table2363152412332" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row122681325193310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p1326813258339">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p52682025153319">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="lts_api_0031__en-us_topic_0000001217316909_p226872516333">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row92691025163311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p9269122520336">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p42692252333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p182692257332">Error code.</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p826922533315">Minimum length: 8 characters</p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1526932510337">Maximum length: 8 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row12269182511339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p82699258331">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p1226972583318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="lts_api_0031__en-us_topic_0000001217316909_p4269102573312">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section740692483316"><h4 class="sectiontitle">Example Request</h4><ul id="lts_api_0031__en-us_topic_0000001217316909_ul182691025123311"><li id="lts_api_0031__en-us_topic_0000001217316909_li1026942563313">Updating an OBS transfer task<div class="p" id="lts_api_0031__en-us_topic_0000001217316909_p126902533314"><a name="lts_api_0031__en-us_topic_0000001217316909_li1026942563313"></a><a name="en-us_topic_0000001217316909_li1026942563313"></a>PUT https://{endpoint}/v2/{project_id}/transfers<pre class="screen" id="lts_api_0031__en-us_topic_0000001217316909_screen1139220496919">PUT https://{endpoint}/v2/{project_id}/transfers
|
|
|
|
/v2/{project_id}/transfers
|
|
{
|
|
"log_transfer_id" : "9f74e101-b969-483c-a610-d3f3064xxxxx",
|
|
"log_transfer_info" : {
|
|
"log_storage_format" : "JSON",
|
|
"log_transfer_status" : "DISABLE",
|
|
"log_transfer_detail" : {
|
|
"obs_period" : 3,
|
|
"obs_period_unit" : "hour",
|
|
"obs_bucket_name" : "0xxx",
|
|
"obs_encrypted_id" : "1bd90032-1424-481f-8558-ba49854xxxxx",
|
|
"obs_dir_pre_fix_name" : "xx",
|
|
"obs_prefix_name" : "xxxxx"
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section10427224153310"><h4 class="sectiontitle">Example Response</h4><p id="lts_api_0031__en-us_topic_0000001217316909_p9332113921219"><strong id="lts_api_0031__en-us_topic_0000001217316909_b39811448115316">Status code: 200</strong></p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p10269725143320">The transfer task is updated.</p>
|
|
<div class="p" id="lts_api_0031__en-us_topic_0000001217316909_p8536155517123">The following parameters are returned for an OBS transfer task:<pre class="screen" id="lts_api_0031__en-us_topic_0000001217316909_screen11790132215123">{
|
|
"log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0",
|
|
"log_group_name" : "lts-group-kafka",
|
|
"log_streams" : [{
|
|
"log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8",
|
|
"log_stream_name" : "lts-topic-kafka"
|
|
}
|
|
],
|
|
"log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc",
|
|
"log_transfer_info" : {
|
|
"log_create_time" : 1634802241847,
|
|
"log_storage_format" : "JSON",
|
|
"log_agency_transfer" : {
|
|
"agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx",
|
|
"agency_domain_name" : "paas_apm_z004xxxxx_xx",
|
|
"agency_name" : "test20210325",
|
|
"agency_project_id" : "2a473356cca5487f8373be891bfxxxxx",
|
|
"be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx",
|
|
"be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx"
|
|
},
|
|
"log_transfer_detail" : {
|
|
"obs_period":2,
|
|
"obs_prefix_name":"",
|
|
"obs_period_unit":"min",
|
|
"obs_transfer_path":"/0002/LogTanks/cn-north-7/",
|
|
"obs_bucket_name":"0002",
|
|
"obs_encrypted_enable":false,
|
|
"obs_dir_pre_fix_name":"",
|
|
"obs_time_zone": "UTC+01:00",
|
|
"obs_time_zone_id": "Africa/Lagos",
|
|
"tags": []
|
|
},
|
|
"log_transfer_mode":"cycle",
|
|
"log_transfer_status":"ENABLE",
|
|
"log_transfer_type":"OBS"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1726932516337"><strong id="lts_api_0031__en-us_topic_0000001217316909_b15710125212532">Status code: 400</strong></p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p5269162593314">Invalid request. Modify the request based on the description in <strong id="lts_api_0031__en-us_topic_0000001217316909_b182188433194354">error_msg</strong> before a retry.</p>
|
|
<pre class="screen" id="lts_api_0031__en-us_topic_0000001217316909_screen12691425143312">{
|
|
"error_code" : "LTS.0207",
|
|
"error_msg" : "The log stream is associated by transfer"
|
|
}</pre>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p1722374791213"><strong id="lts_api_0031__en-us_topic_0000001217316909_b1779013548534">Status code: 500</strong></p>
|
|
<p id="lts_api_0031__en-us_topic_0000001217316909_p13269182543313">The server has received the request but encountered an internal error.</p>
|
|
<pre class="screen" id="lts_api_0031__en-us_topic_0000001217316909_screen92698254333">{
|
|
"error_code" : "LTS.0010",
|
|
"error_msg" : "The system encountered an internal error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section647842417338"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0031__en-us_topic_0000001217316909_table18481202420338" frame="border" border="1" rules="all"><thead align="left"><tr id="lts_api_0031__en-us_topic_0000001217316909_row1826982519331"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="lts_api_0031__en-us_topic_0000001217316909_p152697254338">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="lts_api_0031__en-us_topic_0000001217316909_p8269102543310">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0031__en-us_topic_0000001217316909_row126942563310"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p626932553318">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p182691725113317">The transfer task is updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row17270162593312"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p8270132553315">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p7270325123315">Invalid request. Modify the request based on the description in <strong id="lts_api_0031__en-us_topic_0000001217316909_b92876573894354">error_msg</strong> before a retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0031__en-us_topic_0000001217316909_row427012259336"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="lts_api_0031__en-us_topic_0000001217316909_p8270172520332">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="lts_api_0031__en-us_topic_0000001217316909_p102701625193317">The server has received the request but encountered an internal error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0031__en-us_topic_0000001217316909_section12510024173318"><h4 class="sectiontitle">Error Codes</h4><p id="lts_api_0031__en-us_topic_0000001217316909_p192704258339">For details, see <a href="lts_02_0021.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="lts_api_0026.html">Log Transfer</a></div>
|
|
</div>
|
|
</div>
|
|
|