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>
180 lines
14 KiB
HTML
180 lines
14 KiB
HTML
<a name="QueryApplicableInstances"></a><a name="QueryApplicableInstances"></a>
|
|
|
|
<h1 class="topictitle1">Querying Instances that a Parameter Template Can Be Applied To</h1>
|
|
<div id="body199105818274"><div class="section" id="QueryApplicableInstances__section2010195882713"><h4 class="sectiontitle">Function</h4><p id="QueryApplicableInstances__p4161058192717">This API is used to query instances that a parameter template can be applied to.</p>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section12018584272"><h4 class="sectiontitle">Constraints</h4><p id="QueryApplicableInstances__p18251158152714">This API supports the following instance types:</p>
|
|
<ul id="QueryApplicableInstances__ul986941081119"><li id="QueryApplicableInstances__li686901021115">GeminiDB Cassandra</li><li id="QueryApplicableInstances__li18559852442"><span id="QueryApplicableInstances__text155661411517">GeminiDB Influx</span></li></ul>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section15591558162715"><h4 class="sectiontitle">URI</h4><p id="QueryApplicableInstances__p56314586276">GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplicableInstances__table1772195812719" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="QueryApplicableInstances__row26710583274"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="QueryApplicableInstances__p187455813277">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="QueryApplicableInstances__p27975892712">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="QueryApplicableInstances__p168475811270">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="QueryApplicableInstances__p3889587276">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplicableInstances__row76717585272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="QueryApplicableInstances__p1195158192719">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="QueryApplicableInstances__p5991558112716">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="QueryApplicableInstances__p20103358122712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="QueryApplicableInstances__p810713581274">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="QueryApplicableInstances__row17671258182712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="QueryApplicableInstances__p191121358172712">config_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="QueryApplicableInstances__p19116458132711">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="QueryApplicableInstances__p1912035812275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="QueryApplicableInstances__p18125165818276">Parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplicableInstances__table71342058182714" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="QueryApplicableInstances__row191292587271"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="QueryApplicableInstances__p1613865832713">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="QueryApplicableInstances__p61431458202719">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="QueryApplicableInstances__p8147758182717">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="QueryApplicableInstances__p61510580270">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplicableInstances__row31291458112718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="QueryApplicableInstances__p1515515585271">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="QueryApplicableInstances__p616065814277">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="QueryApplicableInstances__p18164115816276">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="QueryApplicableInstances__p111711858152715">Index offset.</p>
|
|
<p id="QueryApplicableInstances__p217405820279">If <strong id="QueryApplicableInstances__b50470545893827">offset</strong> is set to <em id="QueryApplicableInstances__i148835231493827">N</em>, the query starts from the <em id="QueryApplicableInstances__i42471107193827">N</em>+1 piece of data. The default value is <strong id="QueryApplicableInstances__b116229136193827">0</strong>, which indicates that the query starts from the first piece of data.</p>
|
|
<p id="QueryApplicableInstances__p1017895814273">The value must be a non-negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplicableInstances__row1812919588272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="QueryApplicableInstances__p7182358112712">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="QueryApplicableInstances__p21861258162715">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="QueryApplicableInstances__p4191858102715">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="QueryApplicableInstances__p1919675813277">Maximum records to be queried.</p>
|
|
<ul id="QueryApplicableInstances__ul020117585279"><li id="QueryApplicableInstances__li11202458112713">The value ranges from <strong id="QueryApplicableInstances__b1036710415212">1</strong> to <strong id="QueryApplicableInstances__b196018516211">100</strong>.</li><li id="QueryApplicableInstances__li6207165814275">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="QueryApplicableInstances__section921311583274"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplicableInstances__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="QueryApplicableInstances__row1822015816276"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="QueryApplicableInstances__p922785813277">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="QueryApplicableInstances__p19232195832719">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="QueryApplicableInstances__p5236155810273">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="QueryApplicableInstances__p10241958202713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplicableInstances__row202206581270"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="QueryApplicableInstances__p5245105816279">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="QueryApplicableInstances__p924915587276">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="QueryApplicableInstances__p02549583274">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="QueryApplicableInstances__p025845810274">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section112641858112714"><h4 class="sectiontitle">Response Parameters</h4><p id="QueryApplicableInstances__p14269135852716">Status code: 200</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="QueryApplicableInstances__response_QueryApplicableInstancesListRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="QueryApplicableInstances__row02731658172719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="QueryApplicableInstances__p102801058192715">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="QueryApplicableInstances__p928411588272">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="QueryApplicableInstances__p16289185815276">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplicableInstances__row327313582274"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="QueryApplicableInstances__p9293158132719">instances</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="QueryApplicableInstances__p8298135820270">Array of <a href="#QueryApplicableInstances__response_ApplicableInstanceRsp">ApplicableInstanceRsp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="QueryApplicableInstances__p8303145862718">All instances.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplicableInstances__row7273558172715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="QueryApplicableInstances__p203073585278">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="QueryApplicableInstances__p163131658112716">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="QueryApplicableInstances__p5317125822712">Maximum number of instances that parameters can be applied to.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="QueryApplicableInstances__response_ApplicableInstanceRsp"></a><a name="response_ApplicableInstanceRsp"></a><table cellpadding="4" cellspacing="0" summary="" id="QueryApplicableInstances__response_ApplicableInstanceRsp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ApplicableInstanceRsp</caption><thead align="left"><tr id="QueryApplicableInstances__row113211858182711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="QueryApplicableInstances__p53287589271">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="QueryApplicableInstances__p733217585272">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="QueryApplicableInstances__p53373586277">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="QueryApplicableInstances__row53219586270"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplicableInstances__p16341155815271">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplicableInstances__p1534525822712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryApplicableInstances__p834945802710">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="QueryApplicableInstances__row63211858172719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="QueryApplicableInstances__p113531758122714">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="QueryApplicableInstances__p835865822719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="QueryApplicableInstances__p8363135816272">Instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section13676581279"><h4 class="sectiontitle">Example Request</h4><ul id="QueryApplicableInstances__ul1337235816278"><li id="QueryApplicableInstances__li1374135812274">URI example<pre class="screen" id="QueryApplicableInstances__screen15379258182710">GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/9e80bf6bbd7142f49761c07e9c32dd04pr06/applicable-instances?offset=0&limit=10</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section4396058112713"><h4 class="sectiontitle">Example Response</h4><p id="QueryApplicableInstances__p16400758142718">Status code: 200</p>
|
|
<p id="QueryApplicableInstances__p13405105872715">Successful response</p>
|
|
<pre class="screen" id="QueryApplicableInstances__screen1341320583278">{
|
|
"instances" : [ {
|
|
"id" : "f38e203908bd4fae82714e88f12600f6in06",
|
|
"name" : "test"
|
|
} ],
|
|
"count" : 1000
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="QueryApplicableInstances__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="QueryApplicableInstances__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="QueryApplicableInstances__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>
|
|
|