forked from docs/doc-exports
zhengxiu
8f6b8d3664
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
143 lines
11 KiB
HTML
143 lines
11 KiB
HTML
<a name="StopLogs"></a><a name="StopLogs"></a>
|
|
|
|
<h1 class="topictitle1">Disabling the Log Backup or Collection Function</h1>
|
|
<div id="body1708331107508"><div class="section" id="StopLogs__section1278918349118"><h4 class="sectiontitle">Function</h4><p id="StopLogs__p137890344118">This API is used to disable log backup or log ingestion for a cluster. Log backup and log ingestion can be disabled separately. After log backup is disabled, any automatic log backup policy configured earlier becomes invalid, and cluster logs cannot be manually back up to OBS either. Disabling log collection for a cluster stops the logs of that cluster from being collected and saved to a specified cluster.</p>
|
|
</div>
|
|
<div class="section" id="StopLogs__section19790133471116"><h4 class="sectiontitle">Calling Method</h4><p id="StopLogs__p77901334101114">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="StopLogs__section12790153418111"><h4 class="sectiontitle">URI</h4><p id="StopLogs__p379033410112">PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopLogs__table137908346113" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="StopLogs__row10790133471116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="StopLogs__p19791143471115">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="StopLogs__p67911934131111">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="StopLogs__p187910347113">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="StopLogs__p379123481119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="StopLogs__row13790153412114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="StopLogs__p1579123410117">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="StopLogs__p13791434141118">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="StopLogs__p19791153412111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="StopLogs__p187911034191113"><strong id="StopLogs__b17911834191117">Definition</strong>:</p>
|
|
<p id="StopLogs__p2079111344119">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
|
|
<p id="StopLogs__p11791173410112"><strong id="StopLogs__b137911934141117">Constraints</strong>:</p>
|
|
<p id="StopLogs__p1579216345111">N/A</p>
|
|
<p id="StopLogs__p1792734141117"><strong id="StopLogs__b1279263491115">Value range</strong>:</p>
|
|
<p id="StopLogs__p187923340112">Project ID of the account.</p>
|
|
<p id="StopLogs__p1079211348115"><strong id="StopLogs__b2792103401119">Default value</strong>:</p>
|
|
<p id="StopLogs__p77929344114">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="StopLogs__row15790203410117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="StopLogs__p87921734181119">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="StopLogs__p479273461116">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="StopLogs__p07925346114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="StopLogs__p7792103410110"><strong id="StopLogs__b19792193420115">Definition</strong>:</p>
|
|
<p id="StopLogs__p12792173418112">ID of the cluster for which log backup or ingestion is to be disabled. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
|
|
<p id="StopLogs__p16792134151118"><strong id="StopLogs__b147921834171117">Constraints</strong>:</p>
|
|
<p id="StopLogs__p1179215347119">N/A</p>
|
|
<p id="StopLogs__p8792183481116"><strong id="StopLogs__b3792123461118">Value range</strong>:</p>
|
|
<p id="StopLogs__p27921434171119">Cluster ID.</p>
|
|
<p id="StopLogs__p147921434161114"><strong id="StopLogs__b17922347119">Default value</strong>:</p>
|
|
<p id="StopLogs__p2792133441111">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopLogs__table127931934171113" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="StopLogs__row14793434171118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="StopLogs__p67931034111116">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="StopLogs__p97933346111">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="StopLogs__p57931934131117">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="StopLogs__p979393419118">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="StopLogs__row379320347113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="StopLogs__p679323419117">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="StopLogs__p15793113491120">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="StopLogs__p1779363414115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="StopLogs__p9793534151113"><strong id="StopLogs__b1794123410113">Definition</strong>:</p>
|
|
<p id="StopLogs__p879415347113">Disables log backup or log collection.</p>
|
|
<p id="StopLogs__p7794153411110"><strong id="StopLogs__b13794123411111">Constraints</strong>:</p>
|
|
<p id="StopLogs__p5794834131113">You can disable log backup or log ingestion only when they have been enabled for the cluster. For details about how to enable log backup or log ingestion, see <a href="StartLogs.html">Enabling Logs</a>.</p>
|
|
<p id="StopLogs__p279453412117"><strong id="StopLogs__b207941234181117">Value range</strong>:</p>
|
|
<ul id="StopLogs__ul14794934181117"><li id="StopLogs__li77941934111120"><p id="StopLogs__p779411344116"><a name="StopLogs__li77941934111120"></a><a name="li77941934111120"></a>base_log_collect: Disables log backup.</p>
|
|
</li><li id="StopLogs__li117941234171112"><p id="StopLogs__p679423421115"><a name="StopLogs__li117941234171112"></a><a name="li117941234171112"></a>real_time_log_collect: Stops log collection.</p>
|
|
</li></ul>
|
|
<p id="StopLogs__p4794163412119"><strong id="StopLogs__b16794234141112">Default value</strong>:</p>
|
|
<p id="StopLogs__p16794123417119">base_log_collect</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="StopLogs__section1779415341111"><h4 class="sectiontitle">Request Parameters</h4><p id="StopLogs__p18794143419118">None</p>
|
|
</div>
|
|
<div class="section" id="StopLogs__section1079413349117"><h4 class="sectiontitle">Response Parameters</h4><p id="StopLogs__p179463491112"><strong id="StopLogs__b179416347116">Status code: 200</strong></p>
|
|
<p id="StopLogs__p679413481111">Request succeeded.</p>
|
|
<p id="StopLogs__p77944343119">None</p>
|
|
</div>
|
|
<div class="section" id="StopLogs__section379423491116"><h4 class="sectiontitle">Example Requests</h4><ul id="StopLogs__ul20794163415110"><li id="StopLogs__li8794163491110"><p id="StopLogs__p117947341112"><a name="StopLogs__li8794163491110"></a><a name="li8794163491110"></a>Disable log backup or log ingestion.</p>
|
|
<pre class="screen" id="StopLogs__screen3795133431117">PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/close?action=base_log_collect</pre>
|
|
</li><li id="StopLogs__li10795183417113"><pre class="screen" id="StopLogs__screen187951234101110">PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/close?action=real_time_log_collect</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="StopLogs__section16795103415117"><h4 class="sectiontitle">Example Responses</h4><p id="StopLogs__p10795113411114">None</p>
|
|
</div>
|
|
<div class="section" id="StopLogs__section1480113418115"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopLogs__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="StopLogs__row6801734101113"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="StopLogs__p1880220342111">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="StopLogs__p1280223461116">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="StopLogs__row1380153415118"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="StopLogs__p20802103417113">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="StopLogs__p11918133411116">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="StopLogs__row19801143491117"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="StopLogs__p19181034151118">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="StopLogs__p13919734131111">Invalid request.</p>
|
|
<p id="StopLogs__p2091913344113">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="StopLogs__row7801123410113"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="StopLogs__p10919143414111">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="StopLogs__p791973417111">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="StopLogs__p13919123414113">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="StopLogs__row18011334161115"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="StopLogs__p79191434141112">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="StopLogs__p1591915345116">The server did not meet one of the preconditions contained in the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="StopLogs__section10919133421114"><h4 class="sectiontitle">Error Codes</h4><p id="StopLogs__p16919173451117">See <a href="css_03_0076.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="log_management.html">Log Management</a></div>
|
|
</div>
|
|
</div>
|
|
|