1
0
forked from docs/doc-exports
doc-exports/docs/css/api-ref/css_03_0094.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
2024-06-07 17:47:08 +00:00

134 lines
8.8 KiB
HTML

<a name="css_03_0094"></a><a name="css_03_0094"></a>
<h1 class="topictitle1">Enabling the Log Function</h1>
<div id="body0000001475869466"><div class="section" id="css_03_0094__section07561117153710"><h4 class="sectiontitle">Function</h4><p id="css_03_0094__p6756161719372">This API is used to enable the log function.</p>
</div>
<div class="section" id="css_03_0094__section57571517183714"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0094__p12757517173719">You can debug this API in . Automatic authentication is supported.</p>
</div>
<div class="section" id="css_03_0094__section137581178379"><h4 class="sectiontitle">URI</h4><p id="css_03_0094__p2075813170372">POST /v1.0/{project_id}/clusters/{cluster_id}/logs/open</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0094__table9761717173719" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0094__row147596179376"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0094__p167624176375">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0094__p177631417203714">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0094__p167641317143716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0094__p576481773716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0094__row17759417123716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0094__p2765817103712">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0094__p1276616174378">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0094__p13766161763716">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0094__p187671917133712">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0094__row3759117133719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0094__p676811173372">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0094__p47689176372">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0094__p197691179376">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0094__p1770161719378">ID of the cluster that you want to enable the log function</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0094__section1577091713714"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0094__request_StartLogsReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter</caption><thead align="left"><tr id="css_03_0094__row20772817113718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="css_03_0094__p7774217143711">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="css_03_0094__p147741217183716">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="css_03_0094__p1077651723715">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="css_03_0094__p27771217143715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0094__row157721517153715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0094__p1777711713719">agency</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0094__p17781617113714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0094__p1677821710375">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0094__p07781117203711">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
</td>
</tr>
<tr id="css_03_0094__row19772141723718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0094__p277981715378">logBasePath</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0094__p1977961773719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0094__p47801717203714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0094__p12781191718374">Storage path of backup logs in the OBS bucket</p>
</td>
</tr>
<tr id="css_03_0094__row577210172374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="css_03_0094__p107821117133712">logBucket</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0094__p5782161715371">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0094__p12783161733720">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0094__p1784717193714">Name of the OBS bucket for storing logs</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0094__section16784617103715"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0094__p1478517179378">None</p>
</div>
<div class="section" id="css_03_0094__section1078591715373"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="css_03_0094__screen278671710375">{
"agency" : "css_obs_agency",
"logBasePath" : "css/log",
"logBucket" : "000-words"
}</pre>
</div>
<div class="section" id="css_03_0094__section10788181712378"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0094__p1778941717374">None</p>
</div>
<div class="section" id="css_03_0094__section478941743720"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0094__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0094__row137908172373"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="css_03_0094__p1479181712379">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="css_03_0094__p4791191714378">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0094__row1379016173375"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0094__p1679271743719">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0094__p67922179373">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0094__row13790171793713"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0094__p379361710375">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0094__p127941017133719">Invalid request.</p>
<p id="css_03_0094__p3794161710370">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0094__row57903170370"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0094__p179631743716">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0094__p1179711173371">The request cannot be processed due to a conflict.</p>
<p id="css_03_0094__p117971317153713">This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.</p>
</td>
</tr>
<tr id="css_03_0094__row197902017123717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="css_03_0094__p197971117173714">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="css_03_0094__p167984175371">The server does not meet one of the requirements that the requester puts on the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0093.html">Log Management</a></div>
</div>
</div>