forked from docs/doc-exports
Wei, Hongmin
da6ca4fb3c
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
386 lines
26 KiB
HTML
386 lines
26 KiB
HTML
<a name="rms_04_0703"></a><a name="rms_04_0703"></a>
|
|
|
|
<h1 class="topictitle1">Listing Advanced Queries</h1>
|
|
<div id="body969325145615"><div class="section" id="rms_04_0703__section870425155616"><h4 class="sectiontitle">Function</h4><p id="rms_04_0703__p47118251567">This API is used to list all advanced queries.</p>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0703__p37116259568">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0703__p1172225175615">GET /v1/resource-manager/domains/{domain_id}/stored-queries</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__table1273025125615" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="rms_04_0703__row16721825105620"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="rms_04_0703__p1573132535614">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="rms_04_0703__p18738250562">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="rms_04_0703__p11745257567">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="rms_04_0703__p87482555614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row472925105613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0703__p1474225195610">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0703__p187462575619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0703__p157552514568">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0703__p175182519569">Specifies tags.</p>
|
|
<p id="rms_04_0703__p1275112515615">Maximum: <strong id="rms_04_0703__b4751425185613">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__table4761255567" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="rms_04_0703__row27502516569"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="rms_04_0703__p1376102517569">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="rms_04_0703__p127714253561">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="rms_04_0703__p107752511569">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="rms_04_0703__p8791525165612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row876525195616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0703__p20791725155612">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0703__p10798259564">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0703__p13792255567">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0703__p9802025105616">Specifies the maximum number of records to return.</p>
|
|
<p id="rms_04_0703__p118032555613">Minimum: <strong id="rms_04_0703__b6804254561">1</strong></p>
|
|
<p id="rms_04_0703__p1480182516569">Maximum: <strong id="rms_04_0703__b168022545615">200</strong></p>
|
|
<p id="rms_04_0703__p280925115616">Default: <strong id="rms_04_0703__b1580172545619">200</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row376202520564"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0703__p1380132513562">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0703__p4804254562">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0703__p128112251569">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0703__p17813253560">Specifies the pagination parameter.</p>
|
|
<p id="rms_04_0703__p581202516567">Minimum: <strong id="rms_04_0703__b1181102518564">4</strong></p>
|
|
<p id="rms_04_0703__p118117253567">Maximum: <strong id="rms_04_0703__b1481182512568">400</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row7764253562"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0703__p48102510566">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0703__p178219250560">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0703__p482152512564">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0703__p158210259560">Specifies the ResourceQL name.</p>
|
|
<p id="rms_04_0703__p188282519569">Minimum: <strong id="rms_04_0703__b16821025155614">1</strong></p>
|
|
<p id="rms_04_0703__p178212510565">Maximum: <strong id="rms_04_0703__b158210257562">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__section38315250569"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0703__row1483152535613"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0703__p15841325135611">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="rms_04_0703__p384142513560">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="rms_04_0703__p6841025165614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="rms_04_0703__p78422519563">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row783925165612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0703__p1485112513565">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0703__p13851725185611">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0703__p13851125145619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0703__p78572517568">Specifies the invoker's token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row483172520563"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0703__p98617253567">X-Security-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0703__p148610259563">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0703__p9861256560">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0703__p2086725105613">Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__section38772517569"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0703__p68714252565"><strong id="rms_04_0703__b158732519564">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__response_StoredQueryListResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0703__row138702510561"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0703__p128852555614">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="rms_04_0703__p98812511561">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="rms_04_0703__p1388112520563">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row98712525612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0703__p2088102520561">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0703__p1389122515560">Array of <a href="#rms_04_0703__response_StoredQuery">StoredQuery</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0703__p88920252569">Specifies the list of advanced queries.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row1987112511562"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0703__p789825145618">page_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0703__p3891425145615"><a href="#rms_04_0703__response_PageInfo">PageInfo</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0703__p149082595616">Specifies the pagination object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rms_04_0703__response_StoredQuery"></a><a name="response_StoredQuery"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__response_StoredQuery" frame="border" border="1" rules="all"><caption><b>Table 5 </b>StoredQuery</caption><thead align="left"><tr id="rms_04_0703__row290525175613"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="rms_04_0703__p10911125135617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="rms_04_0703__p1911625125619">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="rms_04_0703__p99113256568">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row1190132555612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p14922259565">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p1292182512562">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p149218259569">ResourceQL ID.</p>
|
|
<p id="rms_04_0703__p79292555613">Maximum: <strong id="rms_04_0703__b15927254564">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row290152565615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p129219255564">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p189218252567">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p0931257568">Specifies the ResourceQL name.</p>
|
|
<p id="rms_04_0703__p1893142555611">Minimum: <strong id="rms_04_0703__b14932254567">1</strong></p>
|
|
<p id="rms_04_0703__p59352505617">Maximum: <strong id="rms_04_0703__b69319259565">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row16842416106"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p1212815341005">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p41291534005">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p1012933420018">Indicates a customized query type. The options are <strong id="rms_04_0703__b198111386117">account</strong> and <strong id="rms_04_0703__b124012117113">aggregator</strong>. account: customized query statement for a single account; If the value is aggregator, it indicates the customized query statement of the aggregator. The default value is <strong id="rms_04_0703__b19041195119">account</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row6909259569"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p1593625165613">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p89372515563">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p89342575620">Specifies the ResourceQL description.</p>
|
|
<p id="rms_04_0703__p1094725155620">Minimum: <strong id="rms_04_0703__b19411253569">0</strong></p>
|
|
<p id="rms_04_0703__p149452515562">Maximum: <strong id="rms_04_0703__b3948255566">512</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row189022515562"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p9941825165620">expression</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p1494725155619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p6941425185618">Specifies the ResourceQL expression.</p>
|
|
<p id="rms_04_0703__p119417257567">Minimum: <strong id="rms_04_0703__b49472512566">1</strong></p>
|
|
<p id="rms_04_0703__p89442511569">Maximum: <strong id="rms_04_0703__b1195182535614">4096</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row79119257566"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p1095152511563">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p15956251566">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p3951025205614">Specifies when ResourceQL was created.</p>
|
|
<p id="rms_04_0703__p195725145614">Minimum: <strong id="rms_04_0703__b1995192585615">1</strong></p>
|
|
<p id="rms_04_0703__p295172513560">Maximum: <strong id="rms_04_0703__b89572513560">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row1691112516567"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0703__p395725175616">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0703__p179632585617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0703__p109612259566">Specifies when ResourceQL was updated.</p>
|
|
<p id="rms_04_0703__p139672535613">Minimum: <strong id="rms_04_0703__b49602511564">1</strong></p>
|
|
<p id="rms_04_0703__p596132585616">Maximum: <strong id="rms_04_0703__b1962025185614">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rms_04_0703__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PageInfo</caption><thead align="left"><tr id="rms_04_0703__row596162545615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="rms_04_0703__p1097182595618">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="rms_04_0703__p15971225145613">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="rms_04_0703__p697132516561">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row8961425125611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0703__p098122555612">current_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0703__p1982025115619">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0703__p99892555611">Specifies the resource quantity on the current page.</p>
|
|
<p id="rms_04_0703__p13981925125617">Minimum: <strong id="rms_04_0703__b1598225155618">0</strong></p>
|
|
<p id="rms_04_0703__p59872515619">Maximum: <strong id="rms_04_0703__b59882519562">200</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row209792555611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0703__p098122515565">next_marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0703__p159982518564">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0703__p29972595616">Specifies the <strong id="rms_04_0703__b99916252568">marker</strong> value of the next page.</p>
|
|
<p id="rms_04_0703__p699132510566">Minimum: <strong id="rms_04_0703__b399102545619">4</strong></p>
|
|
<p id="rms_04_0703__p7100132519563">Maximum: <strong id="rms_04_0703__b510012518563">400</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="rms_04_0703__p51001725165611"><strong id="rms_04_0703__b1710032515617">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0703__row121001525135614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="rms_04_0703__p91011525145615">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="rms_04_0703__p111011925155612">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="rms_04_0703__p16101172585618">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row410092525616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0703__p10101325165618">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0703__p11102172525616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0703__p181021925185617">Specifies the error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row5100122519566"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0703__p151021225205610">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0703__p410211252564">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0703__p14103122565613">Specifies the error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="rms_04_0703__p310312517566"><strong id="rms_04_0703__b8103162513563">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__response_ErrorResp_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0703__row12103425105620"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="rms_04_0703__p14104142511564">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="rms_04_0703__p910472518567">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="rms_04_0703__p14105425145612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row1104122518567"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0703__p9105132514566">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0703__p13105152518560">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0703__p410552513569">Specifies the error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row19104172517561"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0703__p1610542516565">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0703__p1910615254562">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0703__p1106925185610">Specifies the error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="rms_04_0703__p410622585616"><strong id="rms_04_0703__b121061325155616">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__response_ErrorResp_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0703__row1010622514564"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="rms_04_0703__p1710772510564">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="rms_04_0703__p13107152514564">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="rms_04_0703__p5108172535614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row210613254569"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0703__p1810818252569">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0703__p511114251569">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0703__p7111182512566">Specifies the error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row1910732525616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0703__p41117254569">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0703__p18112102595615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0703__p4112825135610">Specifies the error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__section711232515566"><h4 class="sectiontitle">Example Requests</h4><p id="rms_04_0703__p151125258562">None</p>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__section0112162514563"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0703__p11113202513565"><strong id="rms_04_0703__b1911313254561">Status code: 200</strong></p>
|
|
<p id="rms_04_0703__p141131225115610">Operation succeeded.</p>
|
|
<pre class="screen" id="rms_04_0703__screen182216465587">{
|
|
"value" : [ {
|
|
"id" : "62b9126566d400721efceffa",
|
|
"name" : "stopped-ecs",
|
|
"type" : "account",
|
|
"description" : "Querying stopped ECSs",
|
|
"expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'SHUTOFF'",
|
|
"created" : "2022-06-27T02:13:57.107Z",
|
|
"updated" : "2022-06-27T02:13:57.107Z"
|
|
} ],
|
|
"page_info" : {
|
|
"current_count" : 1,
|
|
"next_marker" : null
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__section12745122595619"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0703__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0703__row12129525135613"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0703__p0745172511565">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="rms_04_0703__p1974552535611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rms_04_0703__row7129202517568"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0703__p137456257562">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0703__p874552535618">Operation succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row8129202516569"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0703__p197451225195612">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0703__p19745202505616">Invalid parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row41291257564"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0703__p3745325165614">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0703__p1974517259568">User authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rms_04_0703__row012932585617"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0703__p8745182515616">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0703__p2745162555619">Server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rms_04_0703__section10745132545620"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0703__p12745325105613">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_04_0700.html">Advanced Queries</a></div>
|
|
</div>
|
|
</div>
|
|
|