forked from docs/doc-exports
Zheng, Xiu
bf0cbd66f9
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>
198 lines
14 KiB
HTML
198 lines
14 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__section1926764117553"><h4 class="sectiontitle">Function</h4><p id="css_03_0097__p526817415550">This API is used to query basic log configurations.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section1426934110556"><h4 class="sectiontitle">URI</h4><p id="css_03_0097__p12269341155513">GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0097__table727110416558" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0097__row92701241145514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0097__p5272144112559">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_0097__p17272941175516">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_0097__p2027217414555">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_0097__p17273341145514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row3270641125519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0097__p1527404113559">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0097__p627494155510">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0097__p19275641185513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0097__p1827594175510">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__row1427111410556"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0097__p1227644118555">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0097__p3276164165517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0097__p227754135515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0097__p1127754115515">ID of the cluster you want to query.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section192781241165514"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0097__p102781341185511">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section527915419550"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0097__p19279441205515"><strong id="css_03_0097__b827924119555">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 parameters</caption><thead align="left"><tr id="css_03_0097__row92801419556"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0097__p1628110413553">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0097__p10282641195515">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0097__p2282144111557">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row1828017412550"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0097__p72821241155512">logConfiguration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0097__p1228374113558"><a href="#css_03_0097__response_logConfiguration">logConfiguration</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0097__p528304119555">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__row1428494110553"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0097__p9286154111551">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0097__p15286241185514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0097__p3287194125514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row72841141205514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p32871041155519">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p10288184110555">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p14288154115555">Log backup ID, which is generated using the system UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row142841241205512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p1728814145514">clusterId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p122890413554">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p828934114555">Cluster ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row9285174135517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p14290141175513">obsBucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p1829112411556">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p3292104110551">Name of the OBS bucket for storing logs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row528594116559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p329364120556">agency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p20293941115520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p42948412554">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row19285194165514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p18294741165511">updateAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p152959414557">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p4295184125513">Update time. Format: Unix timestamp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row13285114118559"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p182961341205516">basePath</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p10297164115517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p7297144114551">Storage path of backed up logs in the OBS bucket.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row7285124115516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p2298104165518">autoEnable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p10298154185516">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p173592419417">Whether the automatic backup is enabled.</p>
|
|
<ul id="css_03_0097__ul12299164118559"><li id="css_03_0097__li1529944105517"><strong id="css_03_0097__b162991541165511">true</strong>: Automatic backup is enabled.</li><li id="css_03_0097__li42998419550"><strong id="css_03_0097__b16300741105516">false</strong>: Automatic backup is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row10285104111557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p17300184155518">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p12301204175517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p193018415555">Start time of automatic log backup. If <strong id="css_03_0097__b630220418556">autoEnable</strong> is set to <strong id="css_03_0097__b73021418558">false</strong>, the value of this parameter is <strong id="css_03_0097__b43023414551">null</strong>. Format: GMT</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row7285204145512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0097__p13022412557">logSwitch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0097__p4302144155515">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0097__p31981352337">Whether the log function is enabled.</p>
|
|
<ul id="css_03_0097__ul330354165513"><li id="css_03_0097__li930314413553"><strong id="css_03_0097__b7304341105515">true</strong>: The log function is enabled.</li><li id="css_03_0097__li7304174117555"><strong id="css_03_0097__b15304641165515">false</strong>: The log function is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section1230512411559"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0097__p6306204112552">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section030784113553"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0097__p193071941145511"><strong id="css_03_0097__b1830818416553">Status code: 200</strong></p>
|
|
<p id="css_03_0097__p73081941105514">Request succeeded.</p>
|
|
<pre class="screen" id="css_03_0097__screen16309641115512">{
|
|
"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" : "16:00 GMT+02:00",
|
|
"logSwitch" : true
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0097__section1731414185513"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0097__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0097__row12315134113555"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0097__p1631604111555">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_0097__p731611415556">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0097__row14315144135514"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0097__p14316194165513">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0097__p5317114115510">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row133155416552"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0097__p2317194115518">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0097__p931816411557">Invalid request.</p>
|
|
<p id="css_03_0097__p14318174120556">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0097__row2315041135518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0097__p73181541135519">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0097__p1831914113553">The request could not be completed due to a conflict with the current state of the resource.</p>
|
|
<p id="css_03_0097__p12319144112551">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_0097__row1315141165520"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0097__p18320124145517">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0097__p73207413555">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>
|
|
|