yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
fix_python
doc-exports/docs/cfw/api-ref/UpdateLogConfig.html
qiaoli 9776db0ee8 First version of the CFW API 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiaoli <qiaoli@huawei.com>
Co-committed-by: qiaoli <qiaoli@huawei.com>
2025-01-21 07:59:01 +00:00

255 lines
19 KiB
HTML
Raw Permalink Blame History

<a name="UpdateLogConfig"></a><a name="UpdateLogConfig"></a>
<h1 class="topictitle1">Updating Log Configurations</h1>
<div id="body1708331107508"><div class="section" id="UpdateLogConfig__section6295172493310"><h4 class="sectiontitle">Function</h4><p id="UpdateLogConfig__p6295192473316">This API is used to update log configurations.</p>
</div>
<div class="section" id="UpdateLogConfig__section52961524123318"><h4 class="sectiontitle">URI</h4><p id="UpdateLogConfig__p13296162416333">PUT /v1/{project_id}/cfw/logs/configuration</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateLogConfig__table0297152410337" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateLogConfig__row13296824113312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateLogConfig__p12971524173320">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateLogConfig__p11297132423311">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateLogConfig__p8297112443319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateLogConfig__p8297102473313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateLogConfig__row729682493313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateLogConfig__p16297152433312">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateLogConfig__p929813243337">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateLogConfig__p1529852443317">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateLogConfig__p162981924103316">Project ID, which can be obtained by calling an API or from the console. For details, see <a href="cfw_02_0015.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateLogConfig__table5299142415338" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="UpdateLogConfig__row12298122417337"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="UpdateLogConfig__p429932419332">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="UpdateLogConfig__p9299112453310">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="UpdateLogConfig__p1729919240337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="UpdateLogConfig__p5299152493317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateLogConfig__row4298182473313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="UpdateLogConfig__p02991324113314">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="UpdateLogConfig__p182993241331">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="UpdateLogConfig__p43000241339">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="UpdateLogConfig__p430072415338">Firewall ID, which can be obtained via <a href="ListFirewallDetail.html">API</a> by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
<tr id="UpdateLogConfig__row1329882473313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="UpdateLogConfig__p1430019243339">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="UpdateLogConfig__p53007240334">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="UpdateLogConfig__p1930018246330">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="UpdateLogConfig__p11301192411336">Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to <a href="cfw_02_0027.html">Obtaining an Enterprise Project ID</a>. If the enterprise project function is not enabled, the value is <strong id="UpdateLogConfig__b230132410331">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateLogConfig__section5301172473317"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateLogConfig__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="UpdateLogConfig__row630122418331"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateLogConfig__p23024248336">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateLogConfig__p1030242493314">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateLogConfig__p7302152473315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateLogConfig__p930242413310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateLogConfig__row15301182443320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateLogConfig__p73021224203317">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateLogConfig__p1130214249334">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateLogConfig__p1930213249339">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateLogConfig__p4303132403313">User token. You can obtain the token by referring to <a href="cfw_02_0029.html">Obtaining a User Token</a>.</p>
</td>
</tr>
<tr id="UpdateLogConfig__row915512398335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateLogConfig__p16987185572214">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateLogConfig__p1453216872313">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateLogConfig__p598785514223">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateLogConfig__p1821149193417">Content type. It can only be set to application/json.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateLogConfig__request_LogConfigDto" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="UpdateLogConfig__row830392410334"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateLogConfig__p14304132453318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateLogConfig__p183041024193316">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateLogConfig__p0305112423311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateLogConfig__p113055242331">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateLogConfig__row163035243331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p33051224133311">fw_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p930542419335">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p43058242331">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p14305182417337">Firewall ID, which can be obtained by referring to <a href="cfw_02_0028.html">Obtaining a Firewall ID</a>.</p>
</td>
</tr>
<tr id="UpdateLogConfig__row18303202411337"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p13306182416338">lts_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p15306524173317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p230632411339">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p630632411332">Whether to enable LTS: <strong id="UpdateLogConfig__b12306424193317">1</strong> (yes), <strong id="UpdateLogConfig__b1830652420338">0</strong> (no).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row12303152416338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p133061324113318">lts_log_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p173065247331">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p130742416332">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p1307124103320">Log Tank Service (LTS) log group ID, which can be obtained by calling the API for querying all the log groups of an account in LTS. Find the value in <strong id="UpdateLogConfig__b16307102453313">log_groups.log_group_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row16303192413331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p18307524193317">lts_attack_log_stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p10307102415331">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p130712240335">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p1030812420336">Attack log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in <strong id="UpdateLogConfig__b73086240336">log_streams.log_stream_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row0304142463313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p18308224103312">lts_attack_log_stream_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p6308524143313">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p12308324183310">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p530872411332">Whether to enable the attack log stream: <strong id="UpdateLogConfig__b730818245339">1</strong> (yes), <strong id="UpdateLogConfig__b1630802473313">0</strong> (no).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row193048244338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p15308182411331">lts_access_log_stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p15309112410338">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p1930952414337">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p173091724133310">Access control log stream ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in <strong id="UpdateLogConfig__b7309192412332">log_streams.log_stream_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row2304172493318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p18309192483315">lts_access_log_stream_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p12309182493319">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p193091724163318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p531022423320">Whether to enable the access control stream: <strong id="UpdateLogConfig__b23105249339">1</strong> (yes), <strong id="UpdateLogConfig__b1131092423314">0</strong> (no).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row1430492453315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p231032453316">lts_flow_log_stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p20310152414337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p17310112415339">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p14310624133314">Traffic log ID, which can be obtained by calling the API for querying all the log streams in a specified log group in LTS. Find the value in <strong id="UpdateLogConfig__b4310152415330">log_streams.log_stream_id</strong> (The period [.] is used to separate different levels of objects).</p>
</td>
</tr>
<tr id="UpdateLogConfig__row7304324123318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateLogConfig__p1331092403320">lts_flow_log_stream_enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateLogConfig__p5311224143315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateLogConfig__p831192413336">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateLogConfig__p17311102413332">Whether to enable the traffic log function: <strong id="UpdateLogConfig__b13311122410335">1</strong> (yes), <strong id="UpdateLogConfig__b10311142443319">0</strong> (no).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateLogConfig__section1831111249339"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateLogConfig__p731119247337"><strong id="UpdateLogConfig__b5312324153315">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateLogConfig__response_HttpUpdateLogConfigResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateLogConfig__row93126240334"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateLogConfig__p131214248334">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateLogConfig__p7312182412333">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdateLogConfig__p17312122418333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateLogConfig__row15312132433310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateLogConfig__p11313142433320">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateLogConfig__p631312246332">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateLogConfig__p16313102453320">Return value for updating log configurations. The value is the firewall ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateLogConfig__section8313824173316"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateLogConfig__p731302416336">Update the log configurations of firewall 22c4a5db-504c-471f-8187-5192bc11de0b in project 408972e72dcd4c1a9b033e955802a36b. The LTS log, flow log, access control log, and attack log functions are disabled.</p>
<pre class="screen" id="UpdateLogConfig__screen163141324143311">https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&amp;enterprise_project_id=default
{
"fw_instance_id" : "22c4a5db-504c-471f-8187-5192bc11de0b",
"lts_enable" : 0,
"lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8",
"lts_attack_log_stream_enable" : 0,
"lts_access_log_stream_enable" : 0,
"lts_flow_log_stream_enable" : 0
}</pre>
</div>
<div class="section" id="UpdateLogConfig__section331510247337"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateLogConfig__p18315102423319"><strong id="UpdateLogConfig__b1831572433312">Status code: 200</strong></p>
<p id="UpdateLogConfig__p23151924103313">Return value for updating log configurations.</p>
<pre class="screen" id="UpdateLogConfig__screen531522473317">{
"data" : "4e113415-7811-4bb3-bf5e-eb835953f7d4"
}</pre>
</div>
<div class="section" id="UpdateLogConfig__section64411824163318"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateLogConfig__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateLogConfig__row433362463315"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdateLogConfig__p1044112433314">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdateLogConfig__p15441824123318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateLogConfig__row6333132463318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateLogConfig__p244120242339">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateLogConfig__p1144192415337">Return value for updating log configurations.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateLogConfig__section644112420337"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateLogConfig__p644116248337">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000008.html">Log Management</a></div>
</div>
</div>
View Git Blame Copy Permalink