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>
651 lines
61 KiB
HTML
651 lines
61 KiB
HTML
<a name="lts_api_0032"></a><a name="lts_api_0032"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Log Transfer Task</h1>
|
|
<div id="body32001227"><div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section05161752113310"><h4 class="sectiontitle">Function</h4><p id="lts_api_0032__en-us_topic_0000001217438349_p81901054193316">This API is used to query an OBS transfer task.</p>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section152095283320"><h4 class="sectiontitle">URI</h4><p id="lts_api_0032__en-us_topic_0000001217438349_p4190125463314">GET /v2/{project_id}/transfers</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table165275527338" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row1119055473319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p7190105453318">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_0032__en-us_topic_0000001217438349_p719055412334">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_0032__en-us_topic_0000001217438349_p101902054173312">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_0032__en-us_topic_0000001217438349_p14190165413317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row21901254183319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p101901254123318">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p13190175423313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p4190195413312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p119045414331">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_0032__en-us_topic_0000001217438349_p619065416332">Minimum length: 32 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p11901054103310">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table3595952123318" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row81901654143314"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p18190195413338">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="lts_api_0032__en-us_topic_0000001217438349_p14190854123310">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="lts_api_0032__en-us_topic_0000001217438349_p2019035423311">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="lts_api_0032__en-us_topic_0000001217438349_p17190954153317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row15190105420331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19190165443316">log_transfer_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p9190954173319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p10190654113318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p619010540338">Log transfer type. You can transfer logs to OBS, DIS, and DMS.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p16190125483315">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul1119065410330"><li id="lts_api_0032__en-us_topic_0000001217438349_li1190185493313"><strong id="lts_api_0032__en-us_topic_0000001217438349_b81901954133313">OBS</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li131902541337"><strong id="lts_api_0032__en-us_topic_0000001217438349_b719035414334">DIS</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li131904543334"><strong id="lts_api_0032__en-us_topic_0000001217438349_b1719013544335">DMS</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row14190105433313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1219018544335">log_group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1019011542333">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1719035463313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p15190165483315">Log group name.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p9190185410333">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p3190165403312">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row4190854113315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p619011545336">log_stream_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p14190354193310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1191185412339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1119155483313">Log stream name.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p121914549337">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1191254193313">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row152059176339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p258mcpsimp">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p260mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p262mcpsimp">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p264mcpsimp">Query cursor. Set the value to 0 in the first query. In subsequent queries, obtain the value from the response to the last request.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p265mcpsimp">Minimum value: <strong id="lts_api_0032__en-us_topic_0000001217438349_b11041528288">0</strong></p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p267mcpsimp">Maximum value: <strong id="lts_api_0032__en-us_topic_0000001217438349_b516754132812">1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row192043176339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p271mcpsimp">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p273mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p275mcpsimp">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p277mcpsimp">Number of records on each page.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p278mcpsimp">Minimum value: <strong id="lts_api_0032__en-us_topic_0000001217438349_b11160191342917">0</strong></p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p280mcpsimp">Maximum value: <strong id="lts_api_0032__en-us_topic_0000001217438349_b66081815152915">100</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section1869511527331"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table1669855233311" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row7191854163311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p4191125419333">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_0032__en-us_topic_0000001217438349_p81911954113319">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_0032__en-us_topic_0000001217438349_p1119175418332">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_0032__en-us_topic_0000001217438349_p191917549334">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row11191125433320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1719115418339">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_0032__en-us_topic_0000001217438349_p819118541337">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p41916548335">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p819115540332">User token obtained from IAM.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p3191125419335">Minimum length: 1000 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p619125493313">Maximum length: 2000 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row1419115463317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p11191115403311">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1419119544335">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p9191254183317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p12191205414335">Set this parameter to <strong id="lts_api_0032__en-us_topic_0000001217438349_b12578356151619">application/json;charset=UTF-8</strong>.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1019145411331">Minimum length: <strong id="lts_api_0032__en-us_topic_0000001217438349_b862620111179">30</strong> characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p2019175411334">Maximum length: <strong id="lts_api_0032__en-us_topic_0000001217438349_b187515713174">30</strong> characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section176517527331"><h4 class="sectiontitle">Response Parameters</h4><p id="lts_api_0032__en-us_topic_0000001217438349_p2191135414335"><strong id="lts_api_0032__en-us_topic_0000001217438349_b21572011165415">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table878010527335" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row151918544336"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p151911754123315">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_0032__en-us_topic_0000001217438349_p41914546339">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_0032__en-us_topic_0000001217438349_p171917549336">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row11916549333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p7191854123315">log_transfers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p101911954153311">Array of <a href="#lts_api_0032__en-us_topic_0000001217438349_table58872528332">Table 5</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19191554143315">Log transfer task information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0032__en-us_topic_0000001217438349_table58872528332"></a><a name="en-us_topic_0000001217438349_table58872528332"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table58872528332" frame="border" border="1" rules="all"><caption><b>Table 5 </b>CreateTransferResponseBody</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row019110547335"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p519125463319">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_0032__en-us_topic_0000001217438349_p11191195414339">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_0032__en-us_topic_0000001217438349_p12191954163312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row7191854143310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p019113543339">log_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p171918547336">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p2191654133311">Log group ID.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p20191155473312">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p61911554103314">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row3191135493310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p13191175413317">log_group_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p121911254123311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p219155414333">Log group name.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p141911654103319">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p19192165415337">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row1219210545337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p11192454173311">log_streams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p41926548333">Array of <a href="#lts_api_0032__en-us_topic_0000001217438349_table9958252153320">Table 6</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p161921654113314">Log stream list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row819225417333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p12192954143319">log_transfer_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1419215493318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p719245453311">Log transfer task ID.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p12192145463313">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p919314549332">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row019315453311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p319335423310">log_transfer_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1619317546339"><a href="#lts_api_0032__en-us_topic_0000001217438349_table185205316336">Table 7</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p31934541338">Log transfer information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0032__en-us_topic_0000001217438349_table9958252153320"></a><a name="en-us_topic_0000001217438349_table9958252153320"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table9958252153320" frame="border" border="1" rules="all"><caption><b>Table 6 </b>log_streams</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row15193185423315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p51931354173317">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_0032__en-us_topic_0000001217438349_p519365483313">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_0032__en-us_topic_0000001217438349_p14193954163313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row1519385413314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p319325493312">log_stream_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p111931554173320">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19193125414331">Log stream ID.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p14193354113316">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1819314542331">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row9193175413336"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p4193154143318">log_stream_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p8193105483311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p141930542339">Log stream name.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p14193554163319">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1719310541334">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0032__en-us_topic_0000001217438349_table185205316336"></a><a name="en-us_topic_0000001217438349_table185205316336"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table185205316336" frame="border" border="1" rules="all"><caption><b>Table 7 </b>log_transfer_info</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row12193165419338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p11931354173314">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_0032__en-us_topic_0000001217438349_p4194155413334">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_0032__en-us_topic_0000001217438349_p1719417540334">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row20194454183312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p121941547339">log_agency_transfer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p17194654143313"><a href="#lts_api_0032__en-us_topic_0000001217438349_table19196953193317">Table 8</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p3194954133311">Information about delegated log transfer. This parameter is returned for a delegated log transfer task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row111941547330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p171943541332">log_create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p0194125413316">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1819485493319">Time when the log transfer task was created.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p51944540338">Minimum value: <strong id="lts_api_0032__en-us_topic_0000001217438349_b234916162546">0</strong></p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p191945545339">Maximum value: <strong id="lts_api_0032__en-us_topic_0000001217438349_b1067817185541">9999999999999</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row8194105483317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p151948547338">log_storage_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1019495412333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p12194135417337">Log transfer format. The value can be <strong id="lts_api_0032__en-us_topic_0000001217438349_b438022172101114">RAW</strong> or <strong id="lts_api_0032__en-us_topic_0000001217438349_b232402142101114">JSON</strong>. <strong id="lts_api_0032__en-us_topic_0000001217438349_b1391027494101114">RAW</strong> indicates raw log format, whereas <strong id="lts_api_0032__en-us_topic_0000001217438349_b1886134316101114">JSON</strong> indicates JSON format. <strong id="lts_api_0032__en-us_topic_0000001217438349_b2116661692101114">JSON</strong> and <strong id="lts_api_0032__en-us_topic_0000001217438349_b1727007712101114">RAW</strong> are supported for OBS and DIS transfer tasks, but only <strong id="lts_api_0032__en-us_topic_0000001217438349_b334747706101114">RAW</strong> is supported for DMS transfer tasks.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p15194654103319">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul14194185493312"><li id="lts_api_0032__en-us_topic_0000001217438349_li51941654163319"><strong id="lts_api_0032__en-us_topic_0000001217438349_b171941654163319">JSON</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li4194185413331"><strong id="lts_api_0032__en-us_topic_0000001217438349_b2194175418332">RAW</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row181941754153318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p31941454113315">log_transfer_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p151941354143320">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p71941054173316">Log transfer details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row15194454123313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p171943541335">log_transfer_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p91941954103313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p919418541333">Log transfer mode. <strong id="lts_api_0032__en-us_topic_0000001217438349_b1139350593101114">cycle</strong> indicates periodical transfer, whereas <strong id="lts_api_0032__en-us_topic_0000001217438349_b371765324101114">realTime</strong> indicates real-time transfer. <strong id="lts_api_0032__en-us_topic_0000001217438349_b114906215101114">cycle</strong> is available to OBS transfer tasks and <strong id="lts_api_0032__en-us_topic_0000001217438349_b1592815017101114">realTime</strong> is available to DIS and DMS transfer tasks.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p119455420333">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul151941548332"><li id="lts_api_0032__en-us_topic_0000001217438349_li15194165413318"><strong id="lts_api_0032__en-us_topic_0000001217438349_b2194354123310">cycle</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li131949547332"><strong id="lts_api_0032__en-us_topic_0000001217438349_b21941654113318">realTime</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row4194105493318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p719465483319">log_transfer_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1619475473312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p15194115415338">Log transfer status. <strong id="lts_api_0032__en-us_topic_0000001217438349_b1853288772101114">ENABLE</strong> indicates that log transfer is enabled, <strong id="lts_api_0032__en-us_topic_0000001217438349_b394675405101114">DISABLE</strong> indicates that log transfer is disabled, and <strong id="lts_api_0032__en-us_topic_0000001217438349_b1000807018101114">EXCEPTION</strong> indicates that log transfer is abnormal.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p419465416334">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul319415463311"><li id="lts_api_0032__en-us_topic_0000001217438349_li1419475453318"><strong id="lts_api_0032__en-us_topic_0000001217438349_b8194105473319">ENABLE</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li2019418542337"><strong id="lts_api_0032__en-us_topic_0000001217438349_b1719415545335">DISABLE</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li111947543339"><strong id="lts_api_0032__en-us_topic_0000001217438349_b161941054123313">EXCEPTION</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row141941554133317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p10194115493313">log_transfer_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1819435483317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1919495411339">Log transfer type. You can transfer logs to OBS, DIS, and DMS.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p151941854123318">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul181948549331"><li id="lts_api_0032__en-us_topic_0000001217438349_li31941654173316"><strong id="lts_api_0032__en-us_topic_0000001217438349_b9194175411330">OBS</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li1719445413312"><strong id="lts_api_0032__en-us_topic_0000001217438349_b919514545333">DIS</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li31951854163315"><strong id="lts_api_0032__en-us_topic_0000001217438349_b14195115419334">DMS</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="lts_api_0032__en-us_topic_0000001217438349_table19196953193317"></a><a name="en-us_topic_0000001217438349_table19196953193317"></a><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table19196953193317" frame="border" border="1" rules="all"><caption><b>Table 8 </b>log_agency_transfer</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row181951454173312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p2019535463316">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="lts_api_0032__en-us_topic_0000001217438349_p51951454133313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="lts_api_0032__en-us_topic_0000001217438349_p71951954183318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row19195254153313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p6195185413312">agency_domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p3195105418339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p9195105423319">Delegator account ID.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p519545493316">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p7195754123315">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row1119555413316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1819515543334">agency_domain_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p019515417339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p14195175473316">Delegator account name.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p12195205415336">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p41951354113319">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row18195105493319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p61951549335">agency_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1419555483312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p21954542333">Name of the agency created by the delegator.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p10195754123311">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1219545473312">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row41951554203315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p16195185453316">agency_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1719512546332">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p6195754163316">Project ID of the delegator.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p9195155453312">Minimum length: 32 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p16195954183318">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row4195125413339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p151951554123313">be_agency_domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p6195145493313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p119517547332">Account ID of the delegated party (ID of the account that created the log transfer task).</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p419585412338">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p7195654123315">Maximum length: 128 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row919545417335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p151951954103315">be_agency_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p8195554143314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1019515541338">Project ID of the delegated party (project ID of the account that created the log transfer task).</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p11195154113312">Minimum length: 32 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p319517541335">Maximum length: 32 characters</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1249684812262"><strong id="lts_api_0032__en-us_topic_0000001217438349_b1781415264544">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table172971453133314" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row51950545337"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p31951554113310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="lts_api_0032__en-us_topic_0000001217438349_p19195195463310">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="lts_api_0032__en-us_topic_0000001217438349_p151951454173318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row4195554143319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p31959549331">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p10195205412338">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1619519546335">Error code.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1019525419333">Minimum length: 8 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p41952054153311">Maximum length: 8 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row319525463320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p519525412333">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p12195554143315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19195135413336">Error message.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p101958548335">Enumerated value:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul12195115415331"><li id="lts_api_0032__en-us_topic_0000001217438349_li7196354143310"><strong id="lts_api_0032__en-us_topic_0000001217438349_b15765164216715">Invalid projectId</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table58071921155313" frame="border" border="1" rules="all"><caption><b>Table 10 </b>log_transfer_detail</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row4991421125310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.5.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p99911821175317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.5.1.2"><p id="lts_api_0032__en-us_topic_0000001217438349_p189912211532">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.5.1.3"><p id="lts_api_0032__en-us_topic_0000001217438349_p299119218539">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.10.2.5.1.4"><p id="lts_api_0032__en-us_topic_0000001217438349_p79911721185319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row1699182125313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p20991102135310">obs_period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p179917211531">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19921321175316">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_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_0032__en-us_topic_0000001217438349_b17608332153217">obs_period</strong> and <strong id="lts_api_0032__en-us_topic_0000001217438349_b15615203283211">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_0032__en-us_topic_0000001217438349_p1199232105314">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul129929212532"><li id="lts_api_0032__en-us_topic_0000001217438349_li699222175313"><strong id="lts_api_0032__en-us_topic_0000001217438349_b13992121155313">1</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li2992102155311"><strong id="lts_api_0032__en-us_topic_0000001217438349_b799242118535">2</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li599242117537"><strong id="lts_api_0032__en-us_topic_0000001217438349_b14992132145314">3</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li699252117532"><strong id="lts_api_0032__en-us_topic_0000001217438349_b159925210539">5</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li1599242118537"><strong id="lts_api_0032__en-us_topic_0000001217438349_b1999242116531">6</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li49921021105314"><strong id="lts_api_0032__en-us_topic_0000001217438349_b13992192114530">12</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li599292120537"><strong id="lts_api_0032__en-us_topic_0000001217438349_b16992421105318">30</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row1399217211532"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p5992162111539">obs_period_unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p13992192145313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p599262119532"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_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_0032__en-us_topic_0000001217438349_b11393144583711">obs_period</strong> and <strong id="lts_api_0032__en-us_topic_0000001217438349_b14400124593717">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_0032__en-us_topic_0000001217438349_p15992102113538">Enumerated values:</p>
|
|
<ul id="lts_api_0032__en-us_topic_0000001217438349_ul79929212535"><li id="lts_api_0032__en-us_topic_0000001217438349_li109921421195312"><strong id="lts_api_0032__en-us_topic_0000001217438349_b129929216531">min</strong></li><li id="lts_api_0032__en-us_topic_0000001217438349_li599212216535"><strong id="lts_api_0032__en-us_topic_0000001217438349_b6992172111537">hour</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row1199272125320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p79925216530">obs_bucket_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p69926216538">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p29921021115313"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p79921210538">OBS bucket name. This parameter is required to update an OBS transfer task.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p599212165312">Minimum length: 3 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p19921821115316">Maximum length: 63 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row79921821155312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p29921921115318">obs_encrypted_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p8992172112539">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p119920216537"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_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_0032__en-us_topic_0000001217438349_p099332117532">Minimum length: 36 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p299342114537">Maximum length: 36 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row17993102115317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p20993122165311">obs_dir_pre_fix_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p5993132113536">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1399362118531"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p4993421155310">Custom transfer path of an OBS transfer task. This parameter is optional.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p5993172145315">The value must match the regular expression:</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p10993112118537">^(/)?([a-zA-Z0-9\._-]+)(/[a-zA-Z0-9\._-]+)*(/)?$</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p399313218532">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p8993182195312">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row149931321205317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p14993121145316">obs_prefix_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19993921205319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p499302113537"><span style="color:#252B3A;">String</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p299342125318">Transfer file prefix of an OBS transfer task. This parameter is optional.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1199312145314">The value must match the regular expression:</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1799332135314">^[a-zA-Z0-9\._-]*$</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p499311217537">Minimum length: 1 character</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p109931212532">Maximum length: 64 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row15873131371418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p5841715121417">obs_transfer_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p15149172715143">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p0841115111415">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p17841915131411">OBS bucket path, which is the log transfer destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row1947719497148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p14224195141416">obs_eps_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p4225951191416">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p746935841411">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p0225175121420">Enterprise project ID of an OBS transfer task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row19586217154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p16652823171518">obs_encrypted_enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1465214237154">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.5.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1137012307159">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.10.2.5.1.4 "><p id="lts_api_0032__en-us_topic_0000001217438349_p9652122318157">Whether OBS bucket encryption is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p271535014152"><strong id="lts_api_0032__en-us_topic_0000001217438349_b52541632195417">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table7343453123311" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row19196155413318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p131965549333">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="lts_api_0032__en-us_topic_0000001217438349_p21961454193319">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="lts_api_0032__en-us_topic_0000001217438349_p1419610547338">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row19196155463319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p8196195473311">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p16196115411333">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p11196195473313">Error code.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p6196175410337">Minimum length: 8 characters</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p12196354193314">Maximum length: 8 characters</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row101961554183318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p10196195463317">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p13196135433315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1919645412335">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section838795353319"><h4 class="sectiontitle">Example Request</h4><p id="lts_api_0032__en-us_topic_0000001217438349_p10481295312">If no parameter is specified, all log transfer tasks are returned. If <strong id="lts_api_0032__en-us_topic_0000001217438349_b10831173881818">log_transfer_type</strong>, <strong id="lts_api_0032__en-us_topic_0000001217438349_b146814435185">log_group_name</strong>, and <strong id="lts_api_0032__en-us_topic_0000001217438349_b1937419460182">log_stream_name</strong> are specified, the corresponding log transfer task is returned.</p>
|
|
<pre class="screen" id="lts_api_0032__en-us_topic_0000001217438349_screen13221556121713">GET https://{endpoint}/v2/{project_id}/transfers
|
|
|
|
/v2/{project_id}/transfers
|
|
/v2/{project_id}/transfers?log_group_name=lts-group-txxx
|
|
/v2/{project_id}/transfers?log_transfer_type=OBS
|
|
/v2/{project_id}/transfers?log_stream_name=lts-topic-testRexxx
|
|
/v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_transfer_type=OBS
|
|
/v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_stream_name=lts-topic-testRxxx
|
|
/v2/{project_id}/transfers?log_transfer_type=OBS&log_stream_name=lts-topic-testRxxx
|
|
/v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_transfer_type=OBS&log_stream_name=lts-topic-testRexxx</pre>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section134021353133319"><h4 class="sectiontitle">Example Response</h4><p id="lts_api_0032__en-us_topic_0000001217438349_p7196145483316"><strong id="lts_api_0032__en-us_topic_0000001217438349_b131118361547">Status code: 200</strong></p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1519635411336">The query is successful.</p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p8536155517123">The following parameters are returned for an OBS transfer task:</p>
|
|
<pre class="screen" id="lts_api_0032__en-us_topic_0000001217438349_screen14629135234019">{
|
|
"log_transfers" : [{
|
|
"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/xxx/",
|
|
"obs_bucket_name":"0002",
|
|
"obs_encrypted_enable":false,
|
|
"obs_dir_pre_fix_name":""
|
|
},
|
|
"log_transfer_mode":"cycle",
|
|
"log_transfer_status":"ENABLE",
|
|
"log_transfer_type":"OBS"
|
|
}
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p20374957165"><strong id="lts_api_0032__en-us_topic_0000001217438349_b11662183925419">Status code: 400</strong></p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1196554183315">Invalid request. Modify the request based on the description in <strong id="lts_api_0032__en-us_topic_0000001217438349_b653578590101114">error_msg</strong> before a retry.</p>
|
|
<pre class="screen" id="lts_api_0032__en-us_topic_0000001217438349_screen41961954163315">{
|
|
"error_code" : "LTS.0205",
|
|
"error_msg" : "The log stream name has been existed"
|
|
}</pre>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p1880261191618"><strong id="lts_api_0032__en-us_topic_0000001217438349_b11935174195416">Status code: 500</strong></p>
|
|
<p id="lts_api_0032__en-us_topic_0000001217438349_p819610543337">The server has received the request but encountered an internal error.</p>
|
|
<pre class="screen" id="lts_api_0032__en-us_topic_0000001217438349_screen10196954143316">{
|
|
"error_code" : "LTS.0010",
|
|
"error_msg" : "The system encountered an internal error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section5456115314337"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0032__en-us_topic_0000001217438349_table1045935333313" frame="border" border="1" rules="all"><thead align="left"><tr id="lts_api_0032__en-us_topic_0000001217438349_row2196165473312"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="lts_api_0032__en-us_topic_0000001217438349_p9196115410335">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_0032__en-us_topic_0000001217438349_p16196175411334">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="lts_api_0032__en-us_topic_0000001217438349_row20196195453318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p1319635433318">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p19197105414334">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row219735415337"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p6197754143320">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p6197135410331">Invalid request. Modify the request based on the description in <strong id="lts_api_0032__en-us_topic_0000001217438349_b1832001360101114">error_msg</strong> before a retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="lts_api_0032__en-us_topic_0000001217438349_row19197154173320"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="lts_api_0032__en-us_topic_0000001217438349_p11971543336">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="lts_api_0032__en-us_topic_0000001217438349_p6197125453319">The server has received the request but encountered an internal error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="lts_api_0032__en-us_topic_0000001217438349_section1049310536332"><h4 class="sectiontitle">Error Codes</h4><p id="lts_api_0032__en-us_topic_0000001217438349_p7197454123315">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>
|
|
|