vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/lts/api-ref/lts_api_0027.html
Hasko, Vladimir 255730fbf9 lts_api (recreate of #279) 
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>
2022-12-02 09:17:17 +00:00

450 lines
37 KiB
HTML
Raw Permalink Blame History

<a name="lts_api_0027"></a><a name="lts_api_0027"></a>
<h1 class="topictitle1">Creating a Log Transfer Task</h1>
<div id="body32001227"><div class="section" id="lts_api_0027__en-us_topic_0266335034_section1947811483267"><h4 class="sectiontitle">Function</h4><p id="lts_api_0027__en-us_topic_0266335034_p247874812268">This API is used to transfer logs of one or more specified log streams to Object Storage Service (OBS).</p>
</div>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section14479448162613"><h4 class="sectiontitle">URI</h4><p id="lts_api_0027__en-us_topic_0266335034_p74791548182614">POST /v2/{project_id}/log-dump/obs</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_table104791448112610" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row447984872612"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p1647915486268">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="lts_api_0027__en-us_topic_0266335034_p1548064818264">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_0027__en-us_topic_0266335034_p15480348172618">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="lts_api_0027__en-us_topic_0266335034_p248074892614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row6479184812613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p17480124812267">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p15480184892616">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p0481194872620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p16481548142614">Project ID. For details about how to obtain the ID, see <a href="lts_api_0006.html#lts_api_0006">Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID</a>.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p24811248192620">Default value: None</p>
<p id="lts_api_0027__en-us_topic_0266335034_p11481144817262">Value length: 32 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section94821848152619"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row1248234814264"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p1548274842614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="lts_api_0027__en-us_topic_0266335034_p348334832618">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_0027__en-us_topic_0266335034_p34832048132614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="lts_api_0027__en-us_topic_0266335034_p9483548142614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row94822048192618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p74831648142612">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1748334816262">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p1448334822618">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p12484164832614">User token obtained from IAM.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p0484848142614">Default value: None</p>
<p id="lts_api_0027__en-us_topic_0266335034_p648404817268">Minimum length: 1000 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p5484448162614">Maximum length: 2000 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row548213484268"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1148434812261">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p12484548132617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p1248413488265">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p195851532162819">Set this parameter to <strong id="lts_api_0027__en-us_topic_0266335034_b12799104713515">application/json;charset=UTF-8</strong>.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p758553219284">Default value: None</p>
<p id="lts_api_0027__en-us_topic_0266335034_p195856323283">Minimum length: 30 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p105851327282">Maximum length: 30 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row1348634862619"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p8487348182614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="lts_api_0027__en-us_topic_0266335034_p10487194872615">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_0027__en-us_topic_0266335034_p548718488266">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="lts_api_0027__en-us_topic_0266335034_p348794842612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row348618483265"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p5487154882613">log_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1487144819262">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p648824872617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p16488154842617">Log group ID.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p348884892616">Value length: 36 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row16486048122619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1548884852619">log_stream_ids</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p15488048152613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p2048864862620">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p348944832611">Indicates IDs of log streams whose logs are to be periodically transferred to OBS. You can specify one or more log streams.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p1748964814261">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul5489144822618"><li id="lts_api_0027__en-us_topic_0266335034_li1648924872610">7bb6b1e7-xxxx-4255-87f9-b3dc7fb2xxxx</li></ul>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row1748684810265"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p13489348172612">obs_bucket_name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1948914872613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p194891848162616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p64896486263">Indicates the name of an OBS bucket.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p549012489265">Minimum length: 3 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p9490848122618">Maximum length: 63 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row1448654812611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p15490154842615">type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p2490548112618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p1249013484262">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p174900480263">Set this parameter to <strong id="lts_api_0027__en-us_topic_0266335034_b12278187192420">cycle</strong>, which indicates that the log transfer is periodic.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p15490348122612">Value length: 5 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row248634816269"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1949154819266">storage_format</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p17976114131014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p4491448172611">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p1649194812261">Indicates whether the logs are stored in raw or JSON format. The default value is <strong id="lts_api_0027__en-us_topic_0266335034_b164153216267">RAW</strong>.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p1649113489261">Minimum length: 3 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p3491114862619">Maximum length: 4 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row10486194810262"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1049244892610">switch_on</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1492184832611">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p94921448172616">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p174924482264">Indicates whether the log transfer is enabled. The value is <strong id="lts_api_0027__en-us_topic_0266335034_b11431134719286">true</strong> (default) or <strong id="lts_api_0027__en-us_topic_0266335034_b176255411287">false</strong>.</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row194861648122618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1949284817264">prefix_name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p14921348112611">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p64921748102615">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p4493348182610">Indicates the file name prefix of the log files transferred to an OBS bucket.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p74931548162611">Minimum length: 0 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p13493548162619">Maximum length: 64 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row5486184815267"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p44932482264">dir_prefix_name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p5493114882616">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p124941148192616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p12494548122612">Indicates a custom path to store the log files.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p449494842615">Minimum length: 0 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p1649424882618">Maximum length: 64 characters</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row648614816266"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p19494348122615">period</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p18494104815264">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p174951148132620">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p1354011497524">Indicates the length of the log transfer interval.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p75401549145211">Example values: <strong id="lts_api_0027__en-us_topic_0266335034_b191245073018">1</strong>, <strong id="lts_api_0027__en-us_topic_0266335034_b10928152133010">2</strong>, <strong id="lts_api_0027__en-us_topic_0266335034_b349615412304">3</strong>, <strong id="lts_api_0027__en-us_topic_0266335034_b18806554306">5</strong>, <strong id="lts_api_0027__en-us_topic_0266335034_b8262165763017">6</strong>, <strong id="lts_api_0027__en-us_topic_0266335034_b168571859193014">12</strong>, and <strong id="lts_api_0027__en-us_topic_0266335034_b18230171793113">30</strong></p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row548684816267"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p7495134852611">period_unit</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1949514802619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p54951348182617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="lts_api_0027__en-us_topic_0266335034_p108731255320">Indicates the unit of the log transfer interval.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p587352205319">Example values: <strong id="lts_api_0027__en-us_topic_0266335034_b696283719552">min</strong> and <strong id="lts_api_0027__en-us_topic_0266335034_b189471539195519">hour</strong></p>
<p id="lts_api_0027__en-us_topic_0266335034_p1187320219539">Minimum length: 3 characters</p>
<p id="lts_api_0027__en-us_topic_0266335034_p1873142175317">Maximum length: 4 characters</p>
<div class="note" id="lts_api_0027__en-us_topic_0266335034_note1974111735314"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="lts_api_0027__en-us_topic_0266335034_p1565912285320">The log transfer interval is specified by the combination of the values of <strong id="lts_api_0027__en-us_topic_0266335034_b1333417815712">period</strong> and <strong id="lts_api_0027__en-us_topic_0266335034_b39921212175711">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>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section6291183498"><h4 class="sectiontitle">Response Parameters</h4><p id="lts_api_0027__en-us_topic_0266335034_p1249684812262"><strong id="lts_api_0027__en-us_topic_0266335034_b20815191217476">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row24961648102618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p1749724852616">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_0027__en-us_topic_0266335034_p6497194842620">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_0027__en-us_topic_0266335034_p1649774822617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row184977482267"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p9498748122615">log_dump_obs_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p649864820264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p1049804811267">Transfer task ID.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p20498104815268">Default value: None</p>
<p id="lts_api_0027__en-us_topic_0266335034_p1049824842617">Value length: 36 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="lts_api_0027__en-us_topic_0266335034_p14498104810260"><strong id="lts_api_0027__en-us_topic_0266335034_b4824018124720">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_table11498134852613" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row149818485261"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p8499104819263">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_0027__en-us_topic_0266335034_p1749964872617">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_0027__en-us_topic_0266335034_p24991748172616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row54991483264"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1850024852611">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1550034862610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p650010482263">Error code.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p9500114810269">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul050034832611"><li id="lts_api_0027__en-us_topic_0266335034_li12500348122615">LTS.0007</li></ul>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row11499124822619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p6501348132612">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1350174812617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p11501184815262">Error message.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p650134842618">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul6265322151415"><li id="lts_api_0027__en-us_topic_0266335034_li15265622121414">The request body format must be json</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="lts_api_0027__en-us_topic_0266335034_p1950594822611"><strong id="lts_api_0027__en-us_topic_0266335034_b910652954720">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_table05051848142612" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row1850514818261"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p1650614484268">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_0027__en-us_topic_0266335034_p12506194842617">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_0027__en-us_topic_0266335034_p20506154892614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row1505164819261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p135081948152611">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p14508348152618">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p950814822613">Error code.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p105084481267">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul1350818484261"><li id="lts_api_0027__en-us_topic_0266335034_li75081548192612">LTS.0403</li></ul>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row95053487261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p450994862610">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1509124892611">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p13509148162612">Error message.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p250974812269">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul050984820262"><li id="lts_api_0027__en-us_topic_0266335034_li950913483263">Invalid projectId</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="lts_api_0027__en-us_topic_0266335034_p1950974842610"><strong id="lts_api_0027__en-us_topic_0266335034_b933016369476">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_table165108480261" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row135101248132612"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p3511748112617">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_0027__en-us_topic_0266335034_p9511194813261">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_0027__en-us_topic_0266335034_p13511104813265">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row1751004810266"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p135111348132616">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p19511184832616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p05111448112612">Error code.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p55111548152613">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul16511148182617"><li id="lts_api_0027__en-us_topic_0266335034_li6512134892615">LTS.0403</li></ul>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row1051084832618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1551264813267">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1951214816262">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="lts_api_0027__en-us_topic_0266335034_p851211481268">Error message.</p>
<p id="lts_api_0027__en-us_topic_0266335034_p1551214811264">Example value:</p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul1751219489268"><li id="lts_api_0027__en-us_topic_0266335034_li12512748102619">Invalid projectId</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section43411431164914"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen17498832135010">POST https://{endpoint}/v2/{project_id}/log-dump/obs
/v2/{project_id}/log-dump/obs
{
"log_group_id": "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053",
"log_stream_ids": ["45e7f609-xxxx-4cd3-835b-xxxx4a124718"],
"obs_bucket_name": "lts-test",
"type": "cycle",
"storage_format": "RAW",
"switch_on": "true",
"prefix_name": "fileprefixname",
"dir_prefix_name": "dirprefixname",
"period": 5,
"period_unit": "min"
}</pre>
</div>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section6958134317504"><h4 class="sectiontitle">Example Response</h4><p id="lts_api_0027__en-us_topic_0266335034_p980213111172"><strong id="lts_api_0027__en-us_topic_0266335034_b112251043194714">Status code: 200</strong></p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul2050064831414"><li id="lts_api_0027__en-us_topic_0266335034_li1450014821417">The log group does not exist.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen138031911201718">{
"error_code": "LTS.0201",
"error_msg": "The log group does not existed"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li1250044815140">The log stream does not exist.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen174161014181917">{
"error_code": "LTS.0208",
"error_msg": "Log stream id does not exist: 632b9bdc-5afd-4666-a5de-2579f8b80314-"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li17500164881416">The OBS bucket does not exist.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen2651159112019">{
"error_code": "LTS.0416",
"error_msg": "obs bucket does not exist: zhuanchu"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li3500174831415">The log stream ID has been associated with a transfer task.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen048695182119">{
"error_code": "LTS.0207",
"error_msg": "Log stream id is associated by transfer: 632b9bdc-5afd-4666-a5de-2579f8b80314"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li950015480141">Invalid transfer type.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen054338132214">{
"error_code": "LTS.1901",
"error_msg": "type is not in the list [cycle]"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li1950034813145">Invalid storage format.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen12468313244">{
"error_code": "LTS.1901",
"error_msg": "storage_format is not in the list [RAW, JSON]"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li15001148141415">Invalid log transfer interval.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen710614353244">{
"error_code": "LTS.1901",
"error_msg": "period+period_unit is not in the list [2min, 5min, 30min, 1hour, 3hour, 6hour, 12hour]"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li13501148171411">Invalid unit of the log transfer interval.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen2653229268">{
"error_code": "LTS.1901",
"error_msg": "period_unit is not in the list [min, hour]"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li850194810147">Invalid file name prefix.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen5936316182610">{
"error_code": "LTS.1902",
"error_msg": "prefix_name is invalid, please verify if it's provided as required"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li185011648161410">Invalid custom path to store log files.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen221863552719">{
"error_code": "LTS.1902",
"error_msg": "dir_prefix_name is invalid, please verify if it's provided as required"
}</pre>
</li></ul>
<p id="lts_api_0027__en-us_topic_0266335034_p9896447502"><strong id="lts_api_0027__en-us_topic_0266335034_b12161354174710">Status code: 201</strong></p>
<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen1389184425011">{
"log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968"
}</pre>
<p id="lts_api_0027__en-us_topic_0266335034_p128919447509"><strong id="lts_api_0027__en-us_topic_0266335034_b1562155724716">Status code: 400</strong></p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul1651622511157"><li id="lts_api_0027__en-us_topic_0266335034_li1516172517152">The request is invalid. Modify the request based on the description in <strong id="lts_api_0027__en-us_topic_0266335034_b8364828163212">error_msg</strong> before a retry.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen128994455014">{
"error_code" : "LTS.0009",
"error_msg" : "Failed to validate the request body"
}</pre>
</li><li id="lts_api_0027__en-us_topic_0266335034_li251617257152">The request is invalid. Modify the request based on the description in <strong id="lts_api_0027__en-us_topic_0266335034_b61291724325">error_msg</strong> before a retry.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen1585911311296">{
"error_code": "LTS.0007",
"error_msg": "The request body format must be json"
}</pre>
</li></ul>
<p id="lts_api_0027__en-us_topic_0266335034_p1689344115014"><strong id="lts_api_0027__en-us_topic_0266335034_b64092744811">Status code: 403</strong></p>
<p id="lts_api_0027__en-us_topic_0266335034_p38954465014">The server understood the request but refused to authorize it. The client should not repeat the request without modifications.</p>
<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen1689114418509">{
"error_code" : "LTS.0001",
"error_msg" : "Invalid projectId"
}</pre>
<p id="lts_api_0027__en-us_topic_0266335034_p118912448500"><strong id="lts_api_0027__en-us_topic_0266335034_b1335271213480">Status code: 500</strong></p>
<ul id="lts_api_0027__en-us_topic_0266335034_ul899714418413"><li id="lts_api_0027__en-us_topic_0266335034_li59971441416">The server has received the request but encountered an internal error.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen188994495011">{
"error_code" : "LTS.0202",
"error_msg" : "Failed to query lts struct log"
}</pre>
</li></ul>
</div>
<ul id="lts_api_0027__en-us_topic_0266335034_ul18997104484112"><li id="lts_api_0027__en-us_topic_0266335034_li599744474111">The server has received the request but encountered an internal error.<pre class="screen" id="lts_api_0027__en-us_topic_0266335034_screen12306194512309">{
"error_code": "LTS.0010",
"error_msg": "Internal Server Error"
}</pre>
</li></ul>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section599894312508"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="lts_api_0027__en-us_topic_0266335034_table2999443135012" frame="border" border="1" rules="all"><thead align="left"><tr id="lts_api_0027__en-us_topic_0266335034_row158944485011"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="lts_api_0027__en-us_topic_0266335034_p2891644175015">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="lts_api_0027__en-us_topic_0266335034_p13891744185015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="lts_api_0027__en-us_topic_0266335034_row662213163513"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p862316317351">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p26232313354">The request has succeeded.</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row158964413503"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p98934495019">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1389154414501">The request has succeeded. The transfer task has been created.</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row589444165020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1589194410509">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p1891244185016">The request is invalid. Modify the request based on the description in <strong id="lts_api_0027__en-us_topic_0266335034_b4656943194119">error_msg</strong> before a retry.</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row589174417509"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p6891744115010">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p28918448504">The server understood the request but refused to authorize it. The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row68954414501"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1689154416501">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p17891144195013">The server has received the request but encountered an internal error.</p>
</td>
</tr>
<tr id="lts_api_0027__en-us_topic_0266335034_row138964405017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="lts_api_0027__en-us_topic_0266335034_p1689644125014">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="lts_api_0027__en-us_topic_0266335034_p15898446509">The requested service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="lts_api_0027__en-us_topic_0266335034_section12493165315425"><h4 class="sectiontitle">Error Codes</h4><p id="lts_api_0027__en-us_topic_0266335034_p670403174213">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>
View Git Blame Copy Permalink