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>
208 lines
16 KiB
HTML
208 lines
16 KiB
HTML
<a name="QueryApplyHistory"></a><a name="QueryApplyHistory"></a>
|
|
|
|
<h1 class="topictitle1">Viewing Application Records of a Parameter Template</h1>
|
|
<div id="body19806134174212"><div class="section" id="QueryApplyHistory__section280854204218"><h4 class="sectiontitle">Function</h4><p id="QueryApplyHistory__p781018434212">This API is used to view application records of a parameter template.</p>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section581304144212"><h4 class="sectiontitle">Constraints</h4><p id="QueryApplyHistory__p78157419421">This API supports the following instance types:</p>
|
|
<ul id="QueryApplyHistory__ul986941081119"><li id="QueryApplyHistory__li686901021115">GeminiDB Cassandra</li><li id="QueryApplyHistory__li18559852442"><span id="QueryApplyHistory__text155661411517">GeminiDB Influx</span></li></ul>
|
|
<p id="QueryApplyHistory__p15538531171713">After an instance is deleted, application records of the parameter template that the instance uses are also deleted.</p>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section1683274114213"><h4 class="sectiontitle">URI</h4><p id="QueryApplyHistory__p58350434212">GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplyHistory__table1884019464217" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="QueryApplyHistory__row1383713474219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="QueryApplyHistory__p1384154164219">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="QueryApplyHistory__p10844104134215">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="QueryApplyHistory__p1846154144214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="QueryApplyHistory__p158484417423">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplyHistory__row128372410422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="QueryApplyHistory__p1985118414421">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="QueryApplyHistory__p1885394184210">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="QueryApplyHistory__p15855124184218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="QueryApplyHistory__p985894114213">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="QueryApplyHistory__row108371342426"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="QueryApplyHistory__p786012411425">config_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="QueryApplyHistory__p1786310454213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="QueryApplyHistory__p198651542429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="QueryApplyHistory__p086718419422">Parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplyHistory__table0873149422" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="QueryApplyHistory__row987064154210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="QueryApplyHistory__p387424174219">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="QueryApplyHistory__p18774444218">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="QueryApplyHistory__p6879114164216">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="QueryApplyHistory__p4881841429">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplyHistory__row28711420422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="QueryApplyHistory__p1588318444211">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="QueryApplyHistory__p388618414421">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="QueryApplyHistory__p188885444213">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="QueryApplyHistory__p138921143421">Index offset.</p>
|
|
<p id="QueryApplyHistory__p28931419424">If <strong id="QueryApplyHistory__b91911680993830">offset</strong> is set to <em id="QueryApplyHistory__i88900778593830">N</em>, the query starts from the <em id="QueryApplyHistory__i4528965893830">N</em>+1 piece of data. The default value is <strong id="QueryApplyHistory__b154742595493830">0</strong>, which indicates that the query starts from the first piece of data.</p>
|
|
<p id="QueryApplyHistory__p1895147426">The value must be a non-negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplyHistory__row48718419421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="QueryApplyHistory__p10898114154212">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="QueryApplyHistory__p179014418429">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="QueryApplyHistory__p6904549427">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="QueryApplyHistory__p290614124213">Maximum records to be queried.</p>
|
|
<ul id="QueryApplyHistory__ul1590934114214"><li id="QueryApplyHistory__li49098494214">The value ranges from <strong id="QueryApplyHistory__b454115642311">1</strong> to <strong id="QueryApplyHistory__b556856162314">100</strong>.</li><li id="QueryApplyHistory__li7912246424">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="QueryApplyHistory__section6916548421"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplyHistory__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="QueryApplyHistory__row49181246424"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="QueryApplyHistory__p13922345423">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="QueryApplyHistory__p1492412411424">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="QueryApplyHistory__p129271840422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="QueryApplyHistory__p1392934174219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplyHistory__row5918124154213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="QueryApplyHistory__p29312413427">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="QueryApplyHistory__p29341848420">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="QueryApplyHistory__p093717413421">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="QueryApplyHistory__p19391942422">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section1694212412420"><h4 class="sectiontitle">Response Parameters</h4><p id="QueryApplyHistory__p1294534194214">Status code: 200</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplyHistory__response_QueryTemplateApplyHistoryListRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="QueryApplyHistory__row49479484213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="QueryApplyHistory__p49516434219">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="QueryApplyHistory__p129533410424">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="QueryApplyHistory__p2095634204219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplyHistory__row1265712945315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="QueryApplyHistory__p281914125712">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="QueryApplyHistory__p128197175711">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="QueryApplyHistory__p181991155712">Total number of records</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplyHistory__row49479416422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="QueryApplyHistory__p19581454215">histories</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="QueryApplyHistory__p2963154124215">Array of <a href="#QueryApplyHistory__response_ApplyHistoryRsp">ApplyHistoryRsp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="QueryApplyHistory__p1896518404214">Application records of a parameter template.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="QueryApplyHistory__response_ApplyHistoryRsp"></a><a name="response_ApplyHistoryRsp"></a><table cellpadding="4" cellspacing="0" summary="" id="QueryApplyHistory__response_ApplyHistoryRsp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ApplyHistoryRsp</caption><thead align="left"><tr id="QueryApplyHistory__row596818414210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="QueryApplyHistory__p17972144114217">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="QueryApplyHistory__p8974134184214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="QueryApplyHistory__p0976104164216">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplyHistory__row16968104154215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplyHistory__p189793474216">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplyHistory__p4981124124214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryApplyHistory__p998684164213">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplyHistory__row149681446429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplyHistory__p998919494213">instance_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplyHistory__p1799111417429">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryApplyHistory__p1399315444212">Instance name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplyHistory__row159687412424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplyHistory__p799613411423">applied_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplyHistory__p799916434210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryApplyHistory__p18225154210">Effective time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
|
|
<p id="QueryApplyHistory__p135145104218"><strong id="QueryApplyHistory__b1295581922510">T</strong> is the separator between calendar and hourly notation of time. <strong id="QueryApplyHistory__b7956919182514">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplyHistory__row69681640429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplyHistory__p1970513421">apply_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplyHistory__p81114515423">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><ul id="QueryApplyHistory__ul121375144210"><li id="QueryApplyHistory__li13141253425"><strong id="QueryApplyHistory__b1318118585264">SUCCESS</strong>: indicates that the parameter template is applied to the corresponding instance.</li><li id="QueryApplyHistory__li103495214289"><strong id="QueryApplyHistory__b49932016164314">Applying</strong>: indicates that the parameter template is being applied to the corresponding instance.</li><li id="QueryApplyHistory__li4161059429"><strong id="QueryApplyHistory__b146918262614">FAILED</strong>: indicates that the parameter template fails to be applied to the corresponding instance.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplyHistory__row1496819410423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplyHistory__p91914516428">failure_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplyHistory__p1321135154215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryApplyHistory__p182415524216">Failure cause.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section22695164212"><h4 class="sectiontitle">Example Requests</h4><ul id="QueryApplyHistory__ul32915516429"><li id="QueryApplyHistory__li193011534216">URI example<pre class="screen" id="QueryApplyHistory__screen13315584214">GET https://{Endpoint}/v3/056f86e8d480d3cb2f43c00183f75e1f/configurations/e02e76567ae04662a2753492b77f965bpr06/applied-histories?offset=0&limit=10</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section14415574214"><h4 class="sectiontitle">Example Responses</h4><p id="QueryApplyHistory__p1144954420">Status code: 200</p>
|
|
<p id="QueryApplyHistory__p046258427">Success</p>
|
|
<pre class="screen" id="QueryApplyHistory__screen25055124219">{
|
|
"total_count" : 1,
|
|
"histories" : [
|
|
{
|
|
"instance_id" : "a2d0cf32db3e4f2aa3a684240e10b457in06",
|
|
"instance_name" : "test",
|
|
"applied_at" : "2022-09-20T11:17:04+0000",
|
|
"apply_result" : "SUCCESS",
|
|
"failure_reason": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="QueryApplyHistory__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="QueryApplyHistory__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="QueryApplyHistory__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>
|
|
|