doc-exports/docs/css/api-ref/css_03_0094.html
Zheng, Xiu bf0cbd66f9 CSS API 22.4.1 Version
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>
2023-04-12 00:11:02 +00:00

132 lines
8.5 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__section689010387461"><h4 class="sectiontitle">Function</h4><p id="css_03_0094__p089013854612">This API is used to enable the log function.</p>
</div>
<div class="section" id="css_03_0094__section18891133819463"><h4 class="sectiontitle">URI</h4><p id="css_03_0094__p178911388469">POST /v1.0/{project_id}/clusters/{cluster_id}/logs/open</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0094__table12895203817469" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0094__row78921938144611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0094__p1689683811462">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0094__p14896203819467">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0094__p108971838104612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0094__p11897193819464">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0094__row19892133884615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0094__p1889713815464">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0094__p08981389466">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0094__p1089803813462">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0094__p1389963854618">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__row16894338154610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0094__p98998389461">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0094__p1900203816465">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0094__p1900438194613">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0094__p1990017386465">ID of the cluster whose log function you want to enable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0094__section390010386463"><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 parameters</caption><thead align="left"><tr id="css_03_0094__row2901113813469"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0094__p16902738104618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="css_03_0094__p1890333810463">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="css_03_0094__p16903153884612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="css_03_0094__p2903163810468">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0094__row4901143812468"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0094__p159045389464">agency</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0094__p1490493817469">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0094__p2904143814612">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0094__p1890413812462">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
</td>
</tr>
<tr id="css_03_0094__row179021938174613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0094__p090583816464">logBasePath</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0094__p8905183818462">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0094__p79053382464">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0094__p9906183816468">Storage path of backed up logs in the OBS bucket.</p>
</td>
</tr>
<tr id="css_03_0094__row169023385469"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0094__p149060382468">logBucket</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0094__p2090743834618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0094__p20907133824618">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0094__p890733820463">Name of the OBS bucket for storing logs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0094__section59081338134617"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0094__p490893834619">None</p>
</div>
<div class="section" id="css_03_0094__section20909838184611"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0094__screen1991073884618">{
"agency" : "css_obs_agency",
"logBasePath" : "css/log",
"logBucket" : "000-words"
}</pre>
</div>
<div class="section" id="css_03_0094__section7912938164610"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0094__p1912103814620">None</p>
</div>
<div class="section" id="css_03_0094__section9912143854614"><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__row1391414382465"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0094__p14915193804619">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0094__p17915193894615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0094__row1491410385460"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0094__p13916133811465">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0094__p191619388466">Request succeeded.</p>
</td>
</tr>
<tr id="css_03_0094__row1391503824610"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0094__p2916143811462">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0094__p591719388464">Invalid request.</p>
<p id="css_03_0094__p1891743820461">Modify the request before retry.</p>
</td>
</tr>
<tr id="css_03_0094__row179150384460"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0094__p291763814611">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0094__p4917103818469">The request could not be completed due to a conflict with the current state of the resource.</p>
<p id="css_03_0094__p10918438204614">The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.</p>
</td>
</tr>
<tr id="css_03_0094__row19151438114617"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0094__p1491863834613">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0094__p15918133810468">The server did not meet one of the preconditions contained in 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>