vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/config/api-ref/rms_04_0101.html
Wei, Hongmin da6ca4fb3c Config API First Version 
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>
2024-08-22 10:49:27 +00:00

510 lines
34 KiB
HTML
Raw Blame History

<a name="rms_04_0101"></a><a name="rms_04_0101"></a>
<h1 class="topictitle1">Querying Resources of a Specific Type</h1>
<div id="body53571557133719"><div class="section" id="rms_04_0101__section1735705743713"><h4 class="sectiontitle">Function</h4><p id="rms_04_0101__p5357857123712">This API is used to query specified resources.To call this API, you must have the <strong id="rms_04_0101__b13357135783717">rms:resources:list</strong> permission. For example,if you need to query the ecs.cloudservers resource type, set the <strong id="rms_04_0101__b9357557153710">provider</strong> to <strong id="rms_04_0101__b1935775773720">ecs</strong>, and <strong id="rms_04_0101__b4358155710379">type</strong> to <strong id="rms_04_0101__b13588573376">cloudservers</strong> in the API request. For details about the cloud services (provider) and resource types (type), see the Supported Services and Resource Types section in the appendix.</p>
</div>
<div class="section" id="rms_04_0101__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0101__p63582057143718">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
</div>
<div class="section" id="rms_04_0101__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0101__p035917574374">GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__table836313578379" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="rms_04_0101__row1136165703718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="rms_04_0101__p153633571371">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_0101__p20364175723711">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_0101__p10364957133718">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_0101__p1336435711379">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row53617575372"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0101__p83641657103713">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0101__p1036545717374">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0101__p1736517578374">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0101__p3365105716371">Specifies tags.</p>
<p id="rms_04_0101__p236513576378">Maximum: <strong id="rms_04_0101__b1736595713370">36</strong></p>
</td>
</tr>
<tr id="rms_04_0101__row12361125720374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0101__p136665713373">provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0101__p736613574371">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0101__p43666572378">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0101__p1736685783718">Specifies the cloud service name.</p>
<p id="rms_04_0101__p1136645715370">Maximum: <strong id="rms_04_0101__b143671257183714">20</strong></p>
</td>
</tr>
<tr id="rms_04_0101__row9362135710376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0101__p1136735717373">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0101__p1367457163716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0101__p18367457183714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0101__p63681257123716">Specifies the resource type.</p>
<p id="rms_04_0101__p23686573377">Maximum: <strong id="rms_04_0101__b1136816574371">32</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__table12370155723718" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="rms_04_0101__row143691057123713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="rms_04_0101__p14371155703717">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_0101__p037195763719">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_0101__p203715577373">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_0101__p103721457103712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row123691757143716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0101__p1637220570373">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0101__p10372125715372">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0101__p193733579378">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0101__p14373185718375">Specifies the region ID.</p>
<p id="rms_04_0101__p337335733717">Maximum: <strong id="rms_04_0101__b437310579377">36</strong></p>
</td>
</tr>
<tr id="rms_04_0101__row636925793718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0101__p1537335711372">ep_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0101__p12374155733715">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0101__p2037405719376">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0101__p15374145711374">Specifies the enterprise project ID.</p>
<p id="rms_04_0101__p1837505718376">Maximum: <strong id="rms_04_0101__b10375175720370">36</strong></p>
</td>
</tr>
<tr id="rms_04_0101__row336945763716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0101__p1437505719378">tag</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0101__p13375185783714">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0101__p53751957163713">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0101__p737617579371">Specifies the tag.</p>
</td>
</tr>
<tr id="rms_04_0101__row93691357163711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0101__p18376175743713">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0101__p1837625713711">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0101__p18376757113720">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0101__p17377145718371">Specifies the maximum number of records to return.</p>
<p id="rms_04_0101__p1637735763715">Minimum: <strong id="rms_04_0101__b6377125723719">1</strong></p>
<p id="rms_04_0101__p143770574371">Maximum: <strong id="rms_04_0101__b3377155713710">200</strong></p>
<p id="rms_04_0101__p14377657143710">Default: <strong id="rms_04_0101__b1237720578377">200</strong></p>
</td>
</tr>
<tr id="rms_04_0101__row1370105719374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0101__p133771057113718">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0101__p73781357133716">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0101__p1237835710373">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0101__p12378165753720">Specifies the pagination parameter.</p>
<p id="rms_04_0101__p1037825753719">Minimum: <strong id="rms_04_0101__b6379057163719">4</strong></p>
<p id="rms_04_0101__p2379115712370">Maximum: <strong id="rms_04_0101__b437915753712">400</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0101__section18379105713377"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0101__row03801057143712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0101__p638218575378">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_0101__p338295712373">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_0101__p738295713371">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_0101__p153822571376">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row193801857163714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0101__p53839572376">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_0101__p73831857133717">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0101__p143835577378">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0101__p738495714379">Specifies the invoker's token.</p>
</td>
</tr>
<tr id="rms_04_0101__row103815578377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0101__p3384195773718">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_0101__p18384195716371">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0101__p6385157123719">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0101__p6385135793718">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_0101__section0385157163719"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0101__p14386057203720"><strong id="rms_04_0101__b538625715377">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__response_ResourceListResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0101__row938610577373"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0101__p238725717370">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_0101__p123888577378">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_0101__p1388115715370">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row1438625715375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0101__p6388757163718">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0101__p1438895753711">Array of <a href="#rms_04_0101__response_ResourceEntity">ResourceEntity</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0101__p133891457173715">Specifies the resource list.</p>
</td>
</tr>
<tr id="rms_04_0101__row738695714377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0101__p2389557143714">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0101__p1338905720379"><a href="#rms_04_0101__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_0101__p4390057193720">Specifies the pagination object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0101__response_ResourceEntity"></a><a name="response_ResourceEntity"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__response_ResourceEntity" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResourceEntity</caption><thead align="left"><tr id="rms_04_0101__row13914578379"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="rms_04_0101__p43941257163717">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_0101__p173941257133711">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_0101__p239495717378">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row139195793713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p12394157163719">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p20395185763715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p839525718371">Specifies the resource ID.</p>
</td>
</tr>
<tr id="rms_04_0101__row103913570379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p23951057123714">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p10395195715373">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p83961575375">Specifies the resource name.</p>
</td>
</tr>
<tr id="rms_04_0101__row103911857103714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p1839625710375">provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p1239735717378">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p11397125710377">Specifies the cloud service name.</p>
</td>
</tr>
<tr id="rms_04_0101__row20391105763711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p173981857173711">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p43983576378">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p6399135710372">Specifies the resource type.</p>
</td>
</tr>
<tr id="rms_04_0101__row1139185712378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p17399175717378">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p19400185713370">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p54001957153717">Specifies the region ID.</p>
</td>
</tr>
<tr id="rms_04_0101__row339205743710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p840055712372">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p17401155711372">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p19401185723715">Specifies the project ID in IaaS OpenStack.</p>
</td>
</tr>
<tr id="rms_04_0101__row12392185763710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p34018578374">project_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p0401657173718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p3402115743718">Specifies the project name in IaaS OpenStack.</p>
</td>
</tr>
<tr id="rms_04_0101__row2392257113710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p204026571371">ep_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p11403155714379">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p240345783710">Specifies the enterprise project ID.</p>
</td>
</tr>
<tr id="rms_04_0101__row123922057183720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p164031257123710">ep_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p15404105793712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p14404957103713">Specifies the name of an enterprise project.</p>
</td>
</tr>
<tr id="rms_04_0101__row15392457203710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p340413577375">checksum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p240485763715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p1340565712375">Specifies the resource checksum.</p>
</td>
</tr>
<tr id="rms_04_0101__row13392115753719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p440585715375">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p1140585733718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p1406165713378">Specifies the time when the resource was created.</p>
</td>
</tr>
<tr id="rms_04_0101__row113923578370"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p54067570376">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p44062057173717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p54071657193717">Specifies the time when the resource was updated.</p>
</td>
</tr>
<tr id="rms_04_0101__row539213574371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p1340775733719">provisioning_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p34079579376">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p040719574378">Specifies the status of a resource operation.</p>
</td>
</tr>
<tr id="rms_04_0101__row11392557173711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p134087578374">state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p54085574377">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p1540885715379">Resource state. The value can be normal or deleted.</p>
</td>
</tr>
<tr id="rms_04_0101__row10392135717376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p164091657103716">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p17409125743719">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p1640910574376">Specifies the resource tag.</p>
</td>
</tr>
<tr id="rms_04_0101__row039395718376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0101__p19409125793713">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0101__p9410105715376">Map&lt;String,Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0101__p1682474781613">Specifies the detailed properties of the resource.</p>
<p id="rms_04_0101__p184101573378">Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0101__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PageInfo</caption><thead align="left"><tr id="rms_04_0101__row24110573370"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="rms_04_0101__p4412195710373">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_0101__p441285718375">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_0101__p18412135713711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row34117577373"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0101__p1141325719374">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0101__p1341375712371">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0101__p1141385715370">Specifies the resource quantity on the current page.</p>
<p id="rms_04_0101__p4413357113715">Minimum: <strong id="rms_04_0101__b2414185716373">0</strong></p>
<p id="rms_04_0101__p15414205714371">Maximum: <strong id="rms_04_0101__b17414257123714">200</strong></p>
</td>
</tr>
<tr id="rms_04_0101__row1941119572379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0101__p1841425763713">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0101__p12414195733713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0101__p1341565715376">Specifies the <strong id="rms_04_0101__b2415957183719">marker</strong> value of the next page.</p>
<p id="rms_04_0101__p5415105753715">Minimum: <strong id="rms_04_0101__b12415115720373">4</strong></p>
<p id="rms_04_0101__p11415357163711">Maximum: <strong id="rms_04_0101__b241512575370">400</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0101__p1641575710373"><strong id="rms_04_0101__b5416115743718">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0101__row18416195733716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="rms_04_0101__p1641745743713">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_0101__p9418115733710">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_0101__p174184577372">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row14416175720377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0101__p1418557103710">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0101__p3419135714378">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0101__p14191357143710">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0101__row441615710379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0101__p241985718373">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0101__p10420185753710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0101__p24201574372">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0101__p1242025763716"><strong id="rms_04_0101__b1342035717370">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__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_0101__row54206577378"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="rms_04_0101__p14426857113711">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_0101__p1442615713378">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_0101__p1742645773720">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row542125793720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0101__p18427165763712">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0101__p114271757143719">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0101__p8427185715376">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0101__row154212057163716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0101__p15428155717375">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0101__p18428185720372">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0101__p642855712376">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0101__p12428195783717"><strong id="rms_04_0101__b134291757143711">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__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_0101__row1242910579372"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="rms_04_0101__p2430185714370">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_0101__p34313579372">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_0101__p6431957123715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row142945793717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0101__p18431757113716">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0101__p184322573371">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0101__p1443245712372">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0101__row1542918572374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0101__p164321357103720">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0101__p10433145713373">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0101__p1143375710374">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0101__section11433195715379"><h4 class="sectiontitle">Example Requests</h4><p id="rms_04_0101__p1143413572379">Querying all VMs in current account</p>
<pre class="screen" id="rms_04_0101__screen04341357173714">GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudServers/resources</pre>
</div>
<div class="section" id="rms_04_0101__section1943435712375"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0101__p154353574376"><strong id="rms_04_0101__b9435757133714">Status code: 200</strong></p>
<p id="rms_04_0101__p2435657113710">Operation succeeded.</p>
<pre class="screen" id="rms_04_0101__screen10437457203710">{
"page_info" : {
"current_count" : 2,
"next_marker" : null
},
"resources" : [ {
"checksum" : "89ca775e88e04b2c200ccbf9e219ad0d7da42e3f446e5c953d443288134eec41",
"created" : "2020-02-21T08:41:05Z",
"ep_id" : "0",
"ep_name" : "default",
"id" : "7ffd8564-d88a-4bc9-ab51-d8b79a57d0e6",
"name" : "ecs-test-1",
"project_id" : "059b5e0a2500d5552fa1c00adada8c06",
"project_name" : "project_name",
"properties" : {
"status" : "ACTIVE"
},
"provider" : "ecs",
"provisioning_state" : "Succeeded",
"region_id" : "regionid1",
"tags" : {
"use" : "test"
},
"type" : "cloudServers",
"updated" : "2020-02-21T08:41:05Z"
}, {
"checksum" : "db2aad42804951c03a724b7501da9b6b4c14d319dd319d76bb7c658f256a37b0",
"created" : "2020-02-24T08:43:05Z",
"ep_id" : "0",
"ep_name" : "default",
"id" : "b63b33b7-f48c-4048-995b-0445d124a445",
"name" : "ecs-test-2",
"project_id" : "059b5e0a2500d5552fa1c00adada8c06",
"project_name" : "project_name_1",
"properties" : {
"status" : "ACTIVE"
},
"provider" : "ecs",
"provisioning_state" : "Succeeded",
"region_id" : "regionid1",
"tags" : {
"use" : "test1"
},
"type" : "cloudServers",
"updated" : "2020-08-11T11:55:08Z"
} ]
}</pre>
</div>
<div class="section" id="rms_04_0101__section124045588379"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0101__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0101__row10471155753711"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0101__p1040513586372">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_0101__p9405175820379">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0101__row447125712372"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0101__p140575873720">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0101__p13405158143711">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_04_0101__row1347185793711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0101__p1640515873713">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0101__p1140525883713">Invalid parameters.</p>
</td>
</tr>
<tr id="rms_04_0101__row44711657133720"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0101__p640575873718">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0101__p10405185853711">User authentication failed.</p>
</td>
</tr>
<tr id="rms_04_0101__row247120572373"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0101__p9405115823719">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0101__p540585833712">Sever error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0101__section1540510589374"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0101__p1440515587378">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_0100.html">Resource Query</a></div>
</div>
</div>
View Git Blame Copy Permalink