forked from docs/doc-exports
wangdengke2
87153b4b9b
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
332 lines
26 KiB
HTML
332 lines
26 KiB
HTML
<a name="dds_api_022"></a><a name="dds_api_022"></a>
|
|
|
|
<h1 class="topictitle1">Querying LTS Log Configurations</h1>
|
|
<div id="body0000002142831253"><div class="section" id="dds_api_022__section4894192115617"><h4 class="sectiontitle">API Description</h4><p id="dds_api_022__p1566734563">This API is used to query LTS log configurations.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_022__section2388134810159"><h4 class="sectiontitle">Restrictions</h4><p id="dds_api_022__p13587123916546">This API is available only for audit logs.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_022__section1389616295612"><h4 class="sectiontitle">URI</h4><ul id="dds_api_022__ul791121595"><li id="dds_api_022__li591812155912">URI format<div class="p" id="dds_api_022__p65649569316"><a name="dds_api_022__li591812155912"></a><a name="li591812155912"></a>GET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table1438681574215" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="dds_api_022__row153861315124219"><th align="left" class="cellrowborder" valign="top" width="19.900000000000002%" id="mcps1.3.3.2.1.1.1.2.5.1.1"><p id="dds_api_022__p88294471429"><strong id="dds_api_022__b1182984754216">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.96%" id="mcps1.3.3.2.1.1.1.2.5.1.2"><p id="dds_api_022__p10829114704218"><strong id="dds_api_022__b1882974794214">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.900000000000002%" id="mcps1.3.3.2.1.1.1.2.5.1.3"><p id="dds_api_022__p482924794219"><strong id="dds_api_022__b138296479423">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.239999999999995%" id="mcps1.3.3.2.1.1.1.2.5.1.4"><p id="dds_api_022__p2082994714425">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row133871415174214"><td class="cellrowborder" valign="top" width="19.900000000000002%" headers="mcps1.3.3.2.1.1.1.2.5.1.1 "><p id="dds_api_022__p738882610020">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.3.2.1.1.1.2.5.1.2 "><p id="dds_api_022__p113886266011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.900000000000002%" headers="mcps1.3.3.2.1.1.1.2.5.1.3 "><p id="dds_api_022__p13891926900">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.239999999999995%" headers="mcps1.3.3.2.1.1.1.2.5.1.4 "><p id="dds_api_022__p77587571027">Project ID of a tenant in a region. To obtain the project ID, see <a href="dds_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table158981117124512" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="dds_api_022__row289811754520"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.2.5.1.1"><p id="dds_api_022__p178986177450">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.2.5.1.2"><p id="dds_api_022__p989841794513"><strong id="dds_api_022__b1189932890">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.689999999999998%" id="mcps1.3.3.2.1.1.2.2.5.1.3"><p id="dds_api_022__p1889891794516"><strong id="dds_api_022__b743719334">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.31%" id="mcps1.3.3.2.1.1.2.2.5.1.4"><p id="dds_api_022__p1589941715455">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row1188744738"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.2.5.1.1 "><p id="dds_api_022__p93155451232">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.2.5.1.2 "><p id="dds_api_022__p53151145831">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.689999999999998%" headers="mcps1.3.3.2.1.1.2.2.5.1.3 "><p id="dds_api_022__p1531584515311">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.31%" headers="mcps1.3.3.2.1.1.2.2.5.1.4 "><p id="dds_api_022__p33158451035">Index offset. If <strong id="dds_api_022__b154951105372">offset</strong> is set to <em id="dds_api_022__i74951109373">N</em>, the resource query starts from the N+1 piece of data. The default value is <strong id="dds_api_022__b14951210153713">0</strong>, indicating that the query starts from the first piece of data. The value must be a positive integer.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row1389991784516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.2.5.1.1 "><p id="dds_api_022__p32891828837">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.2.5.1.2 "><p id="dds_api_022__p1328910287313">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.689999999999998%" headers="mcps1.3.3.2.1.1.2.2.5.1.3 "><p id="dds_api_022__p16289202812316">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.31%" headers="mcps1.3.3.2.1.1.2.2.5.1.4 "><p id="dds_api_022__p228915286316">Number of records to be queried. The value ranges from 0 to 50. If this parameter is not transferred, the log configurations of the first 50 DB instances are queried by default.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table23896261404" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request parameters</caption><thead align="left"><tr id="dds_api_022__row93889261102"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.3.2.5.1.1"><p id="dds_api_022__p1538710261103"><strong id="dds_api_022__b0934133616589">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.3.2.5.1.2"><p id="dds_api_022__p133871026302"><strong id="dds_api_022__b9224173810581">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.3.2.5.1.3"><p id="dds_api_022__p143880261108"><strong id="dds_api_022__b8376239155812">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.3.2.5.1.4"><p id="dds_api_022__p6388112615015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row6388326307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.3.2.5.1.1 "><p id="dds_api_022__p1838813261804">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.3.2.5.1.2 "><p id="dds_api_022__p1938814261015">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.3.2.5.1.3 "><p id="dds_api_022__p338820261201">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.3.2.5.1.4 "><p id="dds_api_022__p1873515157396">User token obtained from IAM.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_022__section187659393189"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_022__ul169379231585"><li id="dds_api_022__li10937162315588">Parameter description<p id="dds_api_022__p207161652175612"><a name="dds_api_022__li10937162315588"></a><a name="li10937162315588"></a>None</p>
|
|
</li><li id="dds_api_022__li73231939125810">Example request<p id="dds_api_022__p16146345347"><a name="dds_api_022__li73231939125810"></a><a name="li73231939125810"></a>Query the log configuration of the first 10 DB instances from the first piece of data.</p>
|
|
<p id="dds_api_022__p67615443584">GET https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/logs/lts-configs?offset=0&limit=10</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_022__section1515174210544"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_022__ul18539131631517"><li id="dds_api_022__li15539916121519">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table46641525244" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_022__row3664182172419"><th align="left" class="cellrowborder" valign="top" width="23.6023602360236%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_022__p1664285804216"><strong id="dds_api_022__b14702831154216">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.652765276527653%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_022__p36421585425"><strong id="dds_api_022__b1173319325426">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.74487448744874%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_022__p1364217588428">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row1979031415257"><td class="cellrowborder" valign="top" width="23.6023602360236%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_022__p10854715172516">instance_lts_configs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.652765276527653%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_022__p168541415152511">Array of <a href="#dds_api_022__table71681845192513">Table 5</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.74487448744874%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_022__p198541015142514">LTS log configuration and brief information about each instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row1863771218253"><td class="cellrowborder" valign="top" width="23.6023602360236%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_022__p485414159257">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.652765276527653%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_022__p98541015112511">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.74487448744874%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_022__p485431592512">Total number of cloud service log configurations that can be queried, which is equal to the total number of DDS instances.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_022__table71681845192513"></a><a name="table71681845192513"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table71681845192513" frame="border" border="1" rules="all"><caption><b>Table 5 </b>instance_lts_configs</caption><thead align="left"><tr id="dds_api_022__row12169134513254"><th align="left" class="cellrowborder" valign="top" width="23.662366236623665%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="dds_api_022__p5753152492616"><strong id="dds_api_022__b127606180441">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.112811281128113%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="dds_api_022__p2753224142618"><strong id="dds_api_022__b1868279862">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.22482248224823%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="dds_api_022__p12753202432613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row12169845172519"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_022__p3635122112619">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.112811281128113%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_022__p14635162114267"><a href="#dds_api_022__table4337123910277">Table 6</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.22482248224823%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_022__p663515214267">Brief information about an instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row39981319112613"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_022__p563532117260">lts_configs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.112811281128113%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_022__p20635102110266">Array of <a href="#dds_api_022__table186524811314">Table lts_configs</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.22482248224823%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_022__p1563562115261">LTS log configuration details. If no LTS log stream is configured, no response is returned for this field.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_022__table4337123910277"></a><a name="table4337123910277"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table4337123910277" frame="border" border="1" rules="all"><caption><b>Table 6 </b>instance</caption><thead align="left"><tr id="dds_api_022__row13371739162710"><th align="left" class="cellrowborder" valign="top" width="23.662366236623665%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="dds_api_022__p1168717429274"><strong id="dds_api_022__b3733433104610">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.04280428042804%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="dds_api_022__p568720423276"><strong id="dds_api_022__b1005760288">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.294829482948295%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="dds_api_022__p13687842142719">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row8338173911274"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p157557166298">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p1755181642911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p048361211234">DDS Instance ID, which can be obtained by calling the API for querying instances and details. If there are no instances available, create one by calling the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row1333813399270"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p3755416162913">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p207552161295">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p10755181615294">DDS Instance name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row163386398271"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p3755916142916">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p275581652918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p12755111692911">Instance type, which can be single node, replica set, or cluster.</p>
|
|
<p id="dds_api_022__p19755171662920">Enumerated values:</p>
|
|
<ul id="dds_api_022__ul675516164292"><li id="dds_api_022__li1575501617299"><strong id="dds_api_022__b11621142182717">ReplicaSingle</strong></li><li id="dds_api_022__li187551316202912"><strong id="dds_api_022__b77554168291">Replica</strong><strong id="dds_api_022__b136391118133316">Set</strong></li><li id="dds_api_022__li1675581616296"><strong id="dds_api_022__b10755316112918">Sharding</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row1233819392278"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p3757151619297">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p19757161619295"><a href="#dds_api_022__table1439519562296">Table 7</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p14757161613294">DB engine and version of the DB instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row17338939192713"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p20758116152919">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p20758191615291">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p16758131619296">Instance status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row3338153992720"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p975810167291">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p4758016112915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p10758416172918">ID of the enterprise project to which the instance belongs. For the default enterprise project, the value is <strong id="dds_api_022__b1955411194486">0</strong>. For other enterprise projects, see <em id="dds_api_022__i17778102484817">Enterprise Management User Guide</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row633993914272"><td class="cellrowborder" valign="top" width="23.662366236623665%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="dds_api_022__p127581116182912">actions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.04280428042804%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="dds_api_022__p0758101662916">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="dds_api_022__p16758191612293">All actions that are being executed on an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_022__table1439519562296"></a><a name="table1439519562296"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table1439519562296" frame="border" border="1" rules="all"><caption><b>Table 7 </b>datastore</caption><thead align="left"><tr id="dds_api_022__row839595632911"><th align="left" class="cellrowborder" valign="top" width="23.482348234823483%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="dds_api_022__p1987916019308"><strong id="dds_api_022__b1243113765210">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.222822282228222%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="dds_api_022__p158791709307"><strong id="dds_api_022__b1277349878">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.294829482948295%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="dds_api_022__p1087960183015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row6395456162914"><td class="cellrowborder" valign="top" width="23.482348234823483%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="dds_api_022__p195343163319">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.222822282228222%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="dds_api_022__p145341216103112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="dds_api_022__p15341416143113">DB engine. The value is <strong id="dds_api_022__b159912541521">mongodb</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row3396135613293"><td class="cellrowborder" valign="top" width="23.482348234823483%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="dds_api_022__p4534201683115">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.222822282228222%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="dds_api_022__p053481613317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="dds_api_022__p9534816183115">Database major version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_022__table186524811314"></a><a name="table186524811314"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table186524811314" frame="border" border="1" rules="all"><caption><b>Table 8 </b>lts_configs</caption><thead align="left"><tr id="dds_api_022__row165748143115"><th align="left" class="cellrowborder" valign="top" width="23.57235723572357%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="dds_api_022__p739385113313"><strong id="dds_api_022__b10350181915316">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.132813281328133%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="dds_api_022__p339317515312"><strong id="dds_api_022__b340301238">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.294829482948295%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="dds_api_022__p139475112312">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row8651148153112"><td class="cellrowborder" valign="top" width="23.57235723572357%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="dds_api_022__p9954113343211">log_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.132813281328133%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="dds_api_022__p2954103373212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="dds_api_022__p695443319328">LTS log type. This parameter cannot be left empty. The only supported option is <strong id="dds_api_022__b546311264174">audit_log</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row1865204812313"><td class="cellrowborder" valign="top" width="23.57235723572357%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="dds_api_022__p995583363211">lts_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.132813281328133%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="dds_api_022__p119551433113211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="dds_api_022__p119551334321">LTS log group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row176612489318"><td class="cellrowborder" valign="top" width="23.57235723572357%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="dds_api_022__p1995503318320">lts_stream_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.132813281328133%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="dds_api_022__p6955183316329">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="dds_api_022__p1195516332323">LTS log stream ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row11665482315"><td class="cellrowborder" valign="top" width="23.57235723572357%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="dds_api_022__p159551133153216">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.132813281328133%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="dds_api_022__p18955173319322">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.294829482948295%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="dds_api_022__p59555336329">Indicates whether to upload logs to LTS.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_022__ul52019421542"><li id="dds_api_022__li1720204216549">Example response<pre class="codeblock" id="dds_api_022__codeblock194364354230">{
|
|
"total_count" : 1,
|
|
"instance_lts_configs" : [ {
|
|
"instance" : {
|
|
"id" : "520c58ba00a3497e97ce0b9604874dd6in02",
|
|
"name" : "dds-1f84",
|
|
"mode" : "ReplicaSingle",
|
|
"datastore" : {
|
|
"type" : "mongodb",
|
|
"version" : 4.0
|
|
},
|
|
"status" : "normal",
|
|
"enterprise_project_id" : "0",
|
|
"actions" : [ "OPS_AUDIT_LOG" ]
|
|
},
|
|
"lts_configs" : [ {
|
|
"log_type" : "audit_log",
|
|
"lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95",
|
|
"lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc",
|
|
"enabled" : true
|
|
} ]
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_022__section10950024562"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_022__table346mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="dds_api_022__row351mcpsimp"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.6.2.1.3.1.1"><p id="dds_api_022__p353mcpsimp">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.6.2.1.3.1.2"><p id="dds_api_022__p355mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_022__row357mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.2.1.3.1.1 "><p id="dds_api_022__p359mcpsimp">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.6.2.1.3.1.2 "><p id="dds_api_022__p557985951715">Success.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_022__row362mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.6.2.1.3.1.1 "><p id="dds_api_022__p364mcpsimp">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.6.2.1.3.1.2 "><p id="dds_api_022__p157499514151">Client or server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dds_api_022__section8954192115620"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_022__en-us_topic_0122053819_p20466124120334">For details, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
<p id="dds_api_022__p15550175313116"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|