forked from docs/doc-exports
Hasko, Vladimir
c1056e5100
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
180 lines
14 KiB
HTML
180 lines
14 KiB
HTML
<a name="ShowInstanceMonitorExtend"></a><a name="ShowInstanceMonitorExtend"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Collection Period of Monitoring by Seconds</h1>
|
|
<div id="body8662426"><div class="section" id="ShowInstanceMonitorExtend__section136315260467"><h4 class="sectiontitle">Function</h4><p id="ShowInstanceMonitorExtend__p76319261461">This API is used to query the collection period of Monitoring by Seconds. Before calling this API:</p>
|
|
<ul id="ShowInstanceMonitorExtend__ul924420236520"><li id="ShowInstanceMonitorExtend__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ShowInstanceMonitorExtend__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section363162616462"><h4 class="sectiontitle">URI</h4><p id="ShowInstanceMonitorExtend__p19641626184619">GET /v3/{project_id}/instances/{instance_id}/monitor-policy</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceMonitorExtend__table20641426124614" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ShowInstanceMonitorExtend__row11641526184618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowInstanceMonitorExtend__p1464142674620">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowInstanceMonitorExtend__p365112618466">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowInstanceMonitorExtend__p365426114619">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowInstanceMonitorExtend__p176572617469">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowInstanceMonitorExtend__row19641826184611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowInstanceMonitorExtend__p86552624614">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowInstanceMonitorExtend__p1365192614468">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowInstanceMonitorExtend__p66582610460">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowInstanceMonitorExtend__p12664261466"></p>
|
|
<p id="ShowInstanceMonitorExtend__p124971021121714">Project ID of a tenant in a region.</p>
|
|
<p id="ShowInstanceMonitorExtend__p0497172116174">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowInstanceMonitorExtend__row1064152613467"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowInstanceMonitorExtend__p1266112624612">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowInstanceMonitorExtend__p566122634616">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowInstanceMonitorExtend__p766182611466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowInstanceMonitorExtend__p26612694613">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section2066152611469"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceMonitorExtend__en-us_topic_0000001244680799_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowInstanceMonitorExtend__row13677260463"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowInstanceMonitorExtend__p46722644619">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowInstanceMonitorExtend__p16672267462">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowInstanceMonitorExtend__p66872616467">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowInstanceMonitorExtend__p1168182624611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowInstanceMonitorExtend__row1467122674612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowInstanceMonitorExtend__p26810269464">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowInstanceMonitorExtend__p146862644617">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowInstanceMonitorExtend__p1568132614461">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowInstanceMonitorExtend__p10682026144610">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowInstanceMonitorExtend__row86742614612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowInstanceMonitorExtend__p169526124619">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowInstanceMonitorExtend__p869526194610">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowInstanceMonitorExtend__p76912269466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowInstanceMonitorExtend__p569182614465">Language.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section26913263463"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowInstanceMonitorExtend__p26942613462"><strong id="ShowInstanceMonitorExtend__b128596427025042">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceMonitorExtend__en-us_topic_0000001244680799_response_TaurusQueryInstanceMonitorResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowInstanceMonitorExtend__row13701126164610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowInstanceMonitorExtend__p570026144613">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowInstanceMonitorExtend__p170626124615">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowInstanceMonitorExtend__p570626104611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowInstanceMonitorExtend__row127014261469"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceMonitorExtend__p8711526124615">monitor_switch</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceMonitorExtend__p771152614616">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceMonitorExtend__p371172610462">Whether to enable Monitoring by Seconds. <strong id="ShowInstanceMonitorExtend__b059518523138">true</strong> indicates that the function is enabled, and <strong id="ShowInstanceMonitorExtend__b1959616526133">false</strong> indicates that the function is disabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowInstanceMonitorExtend__row670122684614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceMonitorExtend__p18711126184617">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceMonitorExtend__p177118262468">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceMonitorExtend__p107113263465">Collection period. This parameter is returned only when <strong id="ShowInstanceMonitorExtend__b171521599133">monitor_switch</strong> is set to <strong id="ShowInstanceMonitorExtend__b1815385918137">true</strong>.</p>
|
|
<ul id="ShowInstanceMonitorExtend__ul98634435248"><li id="ShowInstanceMonitorExtend__li5863143102419"><strong id="ShowInstanceMonitorExtend__b20954350101610">1</strong>: The collection period is 1s.</li><li id="ShowInstanceMonitorExtend__li693145218248"><strong id="ShowInstanceMonitorExtend__b24412573164">5</strong>: The collection period is 5s.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowInstanceMonitorExtend__p272122614463"><strong id="ShowInstanceMonitorExtend__b2726635425233">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceMonitorExtend__en-us_topic_0000001244680799_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowInstanceMonitorExtend__row672162618469"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowInstanceMonitorExtend__p1772026154613">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowInstanceMonitorExtend__p7727264462">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowInstanceMonitorExtend__p673202611469">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowInstanceMonitorExtend__row2728269463"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowInstanceMonitorExtend__p4731926194613">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowInstanceMonitorExtend__p873726174610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowInstanceMonitorExtend__p273172644614">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowInstanceMonitorExtend__row37232674613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowInstanceMonitorExtend__p1773162617465">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowInstanceMonitorExtend__p17747261461">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowInstanceMonitorExtend__p2074172620467">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowInstanceMonitorExtend__p7741026134611"><strong id="ShowInstanceMonitorExtend__b1374226184617">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceMonitorExtend__table67482644610" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowInstanceMonitorExtend__row117452615462"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowInstanceMonitorExtend__p127492620464">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowInstanceMonitorExtend__p11750262468">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowInstanceMonitorExtend__p075126104612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowInstanceMonitorExtend__row18741726184615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowInstanceMonitorExtend__p775026164610">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowInstanceMonitorExtend__p1875172615466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowInstanceMonitorExtend__p175172684615">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowInstanceMonitorExtend__row474132604619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowInstanceMonitorExtend__p16759268461">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowInstanceMonitorExtend__p57622617462">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowInstanceMonitorExtend__p147642611466">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section2076126144610"><h4 class="sectiontitle">Example Request</h4><p id="ShowInstanceMonitorExtend__p1476202674618">Querying the collection period of Monitoring by Seconds for an instance</p>
|
|
<pre class="screen" id="ShowInstanceMonitorExtend__screen11553439113410">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/monitor-policy</pre>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section77612618463"><h4 class="sectiontitle">Example Response</h4><p id="ShowInstanceMonitorExtend__p1477192654615"><strong id="ShowInstanceMonitorExtend__b113542492425042">Status code: 200</strong></p>
|
|
<p id="ShowInstanceMonitorExtend__p777152619462">Success.</p>
|
|
<pre class="screen" id="ShowInstanceMonitorExtend__screen27710266461">{
|
|
"monitor_switch" : true,
|
|
"period" : "1"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section8374140175216"><h4 class="sectiontitle">Status Code</h4><p id="ShowInstanceMonitorExtend__p1337415085214">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="ShowInstanceMonitorExtend__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="ShowInstanceMonitorExtend__p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0003.html">Managing DB Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|