forked from docs/doc-exports
wangdengke2
59805c5073
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>
225 lines
18 KiB
HTML
225 lines
18 KiB
HTML
<a name="QueryModifyHistory"></a><a name="QueryModifyHistory"></a>
|
|
|
|
<h1 class="topictitle1">Viewing Parameter Change History of an Instance</h1>
|
|
<div id="body634884313414"><div class="section" id="QueryModifyHistory__section10349143173411"><h4 class="sectiontitle">Function</h4><p id="QueryModifyHistory__p15351743193415">This API is used to view change history of parameters of an instance.</p>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section735394318346"><h4 class="sectiontitle">Constraints</h4><p id="QueryModifyHistory__p17354144353413">This API supports the following instance types:</p>
|
|
<ul id="QueryModifyHistory__ul986941081119"><li id="QueryModifyHistory__li686901021115"><span id="QueryModifyHistory__text10535142517513">GeminiDB Cassandra</span></li><li id="QueryModifyHistory__li486901012111"><span id="QueryModifyHistory__text155661411517">GeminiDB Influx</span></li></ul>
|
|
<p id="QueryModifyHistory__p6917151318421">This API can be used to query only the past seven days of parameter changes.</p>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section736654353411"><h4 class="sectiontitle">URI</h4><p id="QueryModifyHistory__p4368194314341">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configuration-histories</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryModifyHistory__table6372443163414" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="QueryModifyHistory__row1537064383410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="QueryModifyHistory__p1537319432340">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="QueryModifyHistory__p83751743103419">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="QueryModifyHistory__p7376184315346">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="QueryModifyHistory__p143781843113419">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryModifyHistory__row19370343123415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="QueryModifyHistory__p15381114314349">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="QueryModifyHistory__p18383134316342">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="QueryModifyHistory__p143841433342">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="QueryModifyHistory__p18386943173410">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row93701643163410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="QueryModifyHistory__p93881043173415">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="QueryModifyHistory__p1738914432345">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="QueryModifyHistory__p18391154318344">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="QueryModifyHistory__p143931243133412">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryModifyHistory__table93971543183418" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="QueryModifyHistory__row239594353414"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="QueryModifyHistory__p63986439345">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="QueryModifyHistory__p1540054312346">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.98%" id="mcps1.3.3.4.2.5.1.3"><p id="QueryModifyHistory__p6402194313343">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.02%" id="mcps1.3.3.4.2.5.1.4"><p id="QueryModifyHistory__p140424323412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryModifyHistory__row1839520438347"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="QueryModifyHistory__p9406943173413">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="QueryModifyHistory__p2408194319344">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.3.4.2.5.1.3 "><p id="QueryModifyHistory__p240915436346">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.3.4.2.5.1.4 "><p id="QueryModifyHistory__p2411164311349">Index offset.</p>
|
|
<p id="QueryModifyHistory__p16413243173419">If <strong id="QueryModifyHistory__b148483467093828">offset</strong> is set to <em id="QueryModifyHistory__i52827967093828">N</em>, the query starts from the <em id="QueryModifyHistory__i178437179093828">N</em>+1 piece of data. The default value is <strong id="QueryModifyHistory__b202113495893828">0</strong>, which indicates that the query starts from the first piece of data.</p>
|
|
<p id="QueryModifyHistory__p154141143113410">The value must be a non-negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row163951843173416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="QueryModifyHistory__p204161643183415">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="QueryModifyHistory__p14418343103418">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.3.4.2.5.1.3 "><p id="QueryModifyHistory__p342110437343">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.02%" headers="mcps1.3.3.4.2.5.1.4 "><p id="QueryModifyHistory__p5422184315342">Maximum records to be queried.</p>
|
|
<ul id="QueryModifyHistory__ul8424943153411"><li id="QueryModifyHistory__li184246437342">The value ranges from <strong id="QueryModifyHistory__b147311737493">1</strong> to <strong id="QueryModifyHistory__b1673317373916">100</strong>.</li><li id="QueryModifyHistory__li1742654315346">If this parameter is not transferred, the first 100 records are queried by default.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section2428204383410"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryModifyHistory__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="QueryModifyHistory__row8430843113417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="QueryModifyHistory__p16433104323415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="QueryModifyHistory__p1743424333419">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="QueryModifyHistory__p144366436345">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="QueryModifyHistory__p94381431345">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryModifyHistory__row1643074373416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="QueryModifyHistory__p8439143173415">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="QueryModifyHistory__p44426435347">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="QueryModifyHistory__p2444043183418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="QueryModifyHistory__p124450439342">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section14447174313419"><h4 class="sectiontitle">Response Parameters</h4><p id="QueryModifyHistory__p1444964353416">Status code: 200</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryModifyHistory__response_QueryParamGroupHistoryListRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="QueryModifyHistory__row1545134314345"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="QueryModifyHistory__p945374303416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="QueryModifyHistory__p845510436342">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="QueryModifyHistory__p94571043153417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryModifyHistory__row16879155718512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="QueryModifyHistory__p053973816278">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="QueryModifyHistory__p1053913384275">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="QueryModifyHistory__p25391438172713">Total number of parameter change records</p>
|
|
<p id="QueryModifyHistory__p85394387271">By default, the total number of parameter change records is returned. If a parameter name is searched, the total number of records that meet the search criteria is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row7451124313341"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="QueryModifyHistory__p1045824312342">histories</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="QueryModifyHistory__p94601343133420">Array of <a href="#QueryModifyHistory__response_ConfigurationHistoryRsp">ConfigurationHistoryRsp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="QueryModifyHistory__p1346216436349">Change history of parameters of an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="QueryModifyHistory__response_ConfigurationHistoryRsp"></a><a name="response_ConfigurationHistoryRsp"></a><table cellpadding="4" cellspacing="0" summary="" id="QueryModifyHistory__response_ConfigurationHistoryRsp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ConfigurationHistoryRsp</caption><thead align="left"><tr id="QueryModifyHistory__row17464114393416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="QueryModifyHistory__p1246784314346">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="QueryModifyHistory__p2469134320346">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="QueryModifyHistory__p154712436341">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryModifyHistory__row0464143153413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p8472443133415">parameter_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p847434383412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryModifyHistory__p4476184314345">Parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row184641943153413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p13478143163413">old_value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p64791743133415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryModifyHistory__p1248164343414">Original parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row1146418432341"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p1348364313417">new_value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p1148544323414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryModifyHistory__p1048611435342">New parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row18464194363411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p44882043113416">update_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p17492343153411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryModifyHistory__p8494443113419">Update result. The value can be:</p>
|
|
<ul id="QueryModifyHistory__ul17968132811473"><li id="QueryModifyHistory__li129682028134714"><strong id="QueryModifyHistory__b1220013515543">SUCCESS</strong>: The operation succeeded.</li><li id="QueryModifyHistory__li1096842874715"><strong id="QueryModifyHistory__b17614157542">FAILED</strong>: The operation failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row14464243203415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p549618435348">applied</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p94977435349">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="QueryModifyHistory__ul1499343123412"><li id="QueryModifyHistory__li1049984333417"><strong id="QueryModifyHistory__b179101726125418">true</strong>: A change is applied.</li><li id="QueryModifyHistory__li25011443113414"><strong id="QueryModifyHistory__b134681029155416">false</strong>: A change is not applied.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row1946584317345"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p7503543193415">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p9505154311344">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryModifyHistory__p1150764314347">Update time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
|
|
<p id="QueryModifyHistory__p10510743133413"><strong id="QueryModifyHistory__b4764255152014">T</strong> is the separator between calendar and hourly notation of time. <strong id="QueryModifyHistory__b67671155192011">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryModifyHistory__row13465124333418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryModifyHistory__p1351174314346">applied_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryModifyHistory__p1751384333415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryModifyHistory__p1051554312349">Update time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
|
|
<p id="QueryModifyHistory__p1518543103414"><strong id="QueryModifyHistory__b1877091552119">T</strong> is the separator between calendar and hourly notation of time. <strong id="QueryModifyHistory__b10771141517211">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section7519543113418"><h4 class="sectiontitle">Example Requests</h4><ul id="QueryModifyHistory__ul4521174315344"><li id="QueryModifyHistory__li1052218437343">URI example<pre class="screen" id="QueryModifyHistory__screen1524143103420">GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/c4e095105bc64797bc3be633ae7201eein10/configuration-histories?offset=0&limit=10</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section11529144313417"><h4 class="sectiontitle">Example Responses</h4><p id="QueryModifyHistory__p1531243123412">Status code: 200</p>
|
|
<p id="QueryModifyHistory__p95331843203411">Success</p>
|
|
<pre class="screen" id="QueryModifyHistory__screen17537154315344">{
|
|
"total_count" : 1,
|
|
"histories" : [ {
|
|
"parameter_name" : "mongos.connPoolMaxShardedConnsPerHost",
|
|
"old_value" : "600",
|
|
"new_value" : "500",
|
|
"update_result" : "FAILED",
|
|
"applied" : true,
|
|
"updated_at" : "2022-09-20T11:17:04+0000",
|
|
"applied_at" : "2022-09-20T11:17:04+0000"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="QueryModifyHistory__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="QueryModifyHistory__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="QueryModifyHistory__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Parameter Templates</a></div>
|
|
</div>
|
|
</div>
|
|
|