forked from docs/doc-exports
Zheng, Xiu
99a2d77599
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>
167 lines
11 KiB
HTML
167 lines
11 KiB
HTML
<a name="css_03_0097"></a><a name="css_03_0097"></a>
|
|
|
|
<h1 class="topictitle1">Querying Basic Log Configurations</h1>
|
|
<div id="body0000001526429713"><div class="section" id="css_03_0097__section10102818123720"><h4 class="sectiontitle">Function</h4><p id="css_03_0097__p11102418143714">This API is used to query basic log configurations.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section11103318113716"><h4 class="sectiontitle">Debugging</h4><p id="css_03_0097__p12103121810379">You can debug this API in . Automatic authentication is supported.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section21041418183714"><h4 class="sectiontitle">URI</h4><p id="css_03_0097__p510510184370">GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0097__table6108718193712" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0097__row51061518123718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0097__p1210991863710">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_0097__p101091618153715">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_0097__p4110111811375">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_0097__p11107181379">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row11107418123715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0097__p1711118189376">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0097__p111151815371">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0097__p1011218183375">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0097__p1811391815379">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_0097__row610711186379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0097__p91141818153714">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0097__p2115161863719">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0097__p311571813711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0097__p191161018103710">ID of the cluster to be queried</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section71171018183716"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0097__p31181189379">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section81191187372"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0097__p9119181833720"><strong id="css_03_0097__b1212905769113028">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0097__response_GetLogSettingResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0097__row212141853710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="css_03_0097__p7122181863711">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="css_03_0097__p19123131813720">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="css_03_0097__p2123718143715">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row1121141812378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="css_03_0097__p112420188378">logConfiguration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="css_03_0097__p112451873716"><a href="#css_03_0097__response_logConfiguration">logConfiguration</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="css_03_0097__p1112591823710">Log configuration entity object</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0097__response_logConfiguration"></a><a name="response_logConfiguration"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0097__response_logConfiguration" frame="border" border="1" rules="all"><caption><b>Table 3 </b>logConfiguration</caption><thead align="left"><tr id="css_03_0097__row2126101833719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="css_03_0097__p141291718163720">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="css_03_0097__p1812971883714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="css_03_0097__p71301018173719">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row3127918173717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p181306181377">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p18131418103713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p013691863720">Log backup ID, which is generated based on the system UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row11127111843719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p18137181814375">clusterId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p4137121815374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p413871883710">Cluster ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row212731813377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p19139171812376">obsBucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p1914091853715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p2140101816378">Name of the OBS bucket for storing logs</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row512781853718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p61418187374">agency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p714171823720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p0142101893715">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row18127101853717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p6142101893715">updateAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p2143718153716">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p101448187374">Update time. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row17127918103710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p141441518183718">basePath</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p10145191816377">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p1014515187378">Storage path of backup logs in the OBS bucket</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row3127151823710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p141464188374">autoEnable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p214781810379">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p191486186371">Indicates whether to enable automatic backup.</p>
|
|
<ul id="css_03_0097__ul17148121863718"><li id="css_03_0097__li614811811379"><strong id="css_03_0097__b115711842385">true</strong>: enabled</li><li id="css_03_0097__li12149418153715"><strong id="css_03_0097__b122712531688">false</strong>: disabled</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row171271218183712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p615011873714">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p17150181811372">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p131511218163718">Start time of automatic log backup. When <strong id="css_03_0097__b2510318795">autoEnable</strong> is set to <strong id="css_03_0097__b1218715261597">false</strong>, the value of this parameter is <strong id="css_03_0097__b1786583115913">null</strong>. Format: GMT</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row1212851893711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="css_03_0097__p1915111817377">logSwitch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="css_03_0097__p131521518143715">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="css_03_0097__p121541118153711">Indicates whether to enable the log function.</p>
|
|
<ul id="css_03_0097__ul215481818376"><li id="css_03_0097__li1115410188374"><strong id="css_03_0097__b121181497102">true</strong>: enabled</li><li id="css_03_0097__li415518189373"><strong id="css_03_0097__b88781813101017">false</strong>: disabled</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section13156121815373"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0097__p8157418133714">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section171571918143716"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0097__p13158171820375"><strong id="css_03_0097__b1371541519113028">Status code: 200</strong></p>
|
|
<p id="css_03_0097__p14158718123718">The request is processed successfully.</p>
|
|
<pre class="screen" id="css_03_0097__screen121591018133714">{
|
|
"logConfiguration" : {
|
|
"id" : "d455a541-597e-4846-a6be-baad0ea361b1",
|
|
"clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
|
|
"obsBucket" : "css-auto-test",
|
|
"agency" : "css_obs_agency",
|
|
"updateAt" : 1633663681055,
|
|
"basePath" : "css/log",
|
|
"autoEnable" : false,
|
|
"period" : "00:00 GMT+08:00",
|
|
"logSwitch" : true
|
|
}
|
|
}</pre>
|
|
</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>
|
|
|