vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/rms/api-ref/rms_02_0008.html
zhangyue 396a19a0bc rms api 2.0.38.SP1 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2022-11-11 13:43:48 +00:00

470 lines
33 KiB
HTML
Raw Blame History

<a name="rms_02_0008"></a><a name="rms_02_0008"></a>
<h1 class="topictitle1">Querying Resources of a Specific Type</h1>
<div id="body314mcpsimp"><div class="section" id="rms_02_0008__section315mcpsimp"><h4 class="sectiontitle">Function</h4><p id="rms_02_0008__p317mcpsimp">This API is to query all your resources of a specific type and you must have the rms:resources:list permission. For example, to query ECSs whose resource type in RMS is ecs.cloudsrevers, you must set <strong id="rms_02_0008__b318mcpsimp">provider</strong> to <strong id="rms_02_0008__b319mcpsimp">ecs</strong> and <strong id="rms_02_0008__b320mcpsimp">type</strong> to <strong id="rms_02_0008__b321mcpsimp">cloudservers</strong> in the request.</p>
</div>
<div class="section" id="rms_02_0008__section322mcpsimp"><h4 class="sectiontitle">URI</h4><p id="rms_02_0008__p324mcpsimp">GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table325mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="rms_02_0008__row333mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="rms_02_0008__p335mcpsimp"><strong id="rms_02_0008__b336mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="rms_02_0008__p338mcpsimp"><strong id="rms_02_0008__b339mcpsimp">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="rms_02_0008__p341mcpsimp"><strong id="rms_02_0008__b342mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="rms_02_0008__p344mcpsimp"><strong id="rms_02_0008__b345mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row347mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="rms_02_0008__p349mcpsimp">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="rms_02_0008__p351mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="rms_02_0008__p353mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="rms_02_0008__p355mcpsimp">Specifies the account ID.</p>
<p id="rms_02_0008__p356mcpsimp">Maximum length: <strong id="rms_02_0008__b357mcpsimp">36</strong></p>
</td>
</tr>
<tr id="rms_02_0008__row358mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="rms_02_0008__p360mcpsimp">provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="rms_02_0008__p362mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="rms_02_0008__p364mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="rms_02_0008__p366mcpsimp">Specifies the cloud service name.</p>
<p id="rms_02_0008__p367mcpsimp">Maximum length: <strong id="rms_02_0008__b368mcpsimp">20</strong></p>
</td>
</tr>
<tr id="rms_02_0008__row369mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="rms_02_0008__p371mcpsimp">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="rms_02_0008__p373mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="rms_02_0008__p375mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="rms_02_0008__p377mcpsimp">Specifies the resource type.</p>
<p id="rms_02_0008__p378mcpsimp">Maximum length: <strong id="rms_02_0008__b379mcpsimp">20</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table380mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="rms_02_0008__row388mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="rms_02_0008__p390mcpsimp"><strong id="rms_02_0008__b391mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="rms_02_0008__p393mcpsimp"><strong id="rms_02_0008__b394mcpsimp">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="rms_02_0008__p396mcpsimp"><strong id="rms_02_0008__b397mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="rms_02_0008__p399mcpsimp"><strong id="rms_02_0008__b400mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row402mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rms_02_0008__p404mcpsimp">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rms_02_0008__p406mcpsimp">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rms_02_0008__p408mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rms_02_0008__p410mcpsimp">Specifies the region ID.</p>
<p id="rms_02_0008__p411mcpsimp">Maximum length: <strong id="rms_02_0008__b412mcpsimp">36</strong></p>
</td>
</tr>
<tr id="rms_02_0008__row413mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rms_02_0008__p415mcpsimp">ep_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rms_02_0008__p417mcpsimp">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rms_02_0008__p419mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rms_02_0008__p421mcpsimp">Specifies the enterprise project ID.</p>
<p id="rms_02_0008__p422mcpsimp">Maximum length: <strong id="rms_02_0008__b423mcpsimp">36</strong></p>
</td>
</tr>
<tr id="rms_02_0008__row424mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rms_02_0008__p426mcpsimp">tag</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rms_02_0008__p428mcpsimp">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rms_02_0008__p430mcpsimp">Object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rms_02_0008__p432mcpsimp">Specifies the resource tag.</p>
</td>
</tr>
<tr id="rms_02_0008__row433mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rms_02_0008__p435mcpsimp">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rms_02_0008__p437mcpsimp">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rms_02_0008__p439mcpsimp">Number</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rms_02_0008__p441mcpsimp">Specifies the maximum number of records to return.</p>
<p id="rms_02_0008__p442mcpsimp">Minimum value: <strong id="rms_02_0008__b443mcpsimp">1</strong></p>
<p id="rms_02_0008__p444mcpsimp">Maximum value: <strong id="rms_02_0008__b445mcpsimp">200</strong></p>
</td>
</tr>
<tr id="rms_02_0008__row446mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rms_02_0008__p448mcpsimp">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rms_02_0008__p450mcpsimp">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rms_02_0008__p452mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rms_02_0008__p454mcpsimp">Specifies the pagination parameter. You can use the <strong id="rms_02_0008__b455mcpsimp">marker</strong> value returned in the previous request as the number of the first page of records to return in this request.</p>
<p id="rms_02_0008__p456mcpsimp">Minimum length: <strong id="rms_02_0008__b457mcpsimp">4</strong></p>
<p id="rms_02_0008__p458mcpsimp">Maximum length: <strong id="rms_02_0008__b459mcpsimp">400</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_02_0008__section460mcpsimp"><h4 class="sectiontitle">Request Parameters</h4><p id="rms_02_0008__p462mcpsimp">None</p>
</div>
<div class="section" id="rms_02_0008__section463mcpsimp"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_02_0008__p465mcpsimp"><strong id="rms_02_0008__b466mcpsimp">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table467mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="rms_02_0008__row474mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="rms_02_0008__p476mcpsimp"><strong id="rms_02_0008__b477mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="rms_02_0008__p479mcpsimp"><strong id="rms_02_0008__b480mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="rms_02_0008__p482mcpsimp"><strong id="rms_02_0008__b483mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row485mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="rms_02_0008__p487mcpsimp">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="rms_02_0008__p489mcpsimp">Array of <a href="#rms_02_0008____d0e2713">Resource Entity</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="rms_02_0008__p492mcpsimp">Specifies the resource list.</p>
</td>
</tr>
<tr id="rms_02_0008__row493mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="rms_02_0008__p495mcpsimp">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="rms_02_0008__p497mcpsimp"><a href="#rms_02_0008____d0e2882">Page Info</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="rms_02_0008__p500mcpsimp">Specifies the pagination object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_02_0008____d0e2713"></a><a name="__d0e2713"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008____d0e2713" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Resource Entity</caption><thead align="left"><tr id="rms_02_0008__row507mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="rms_02_0008__p509mcpsimp"><strong id="rms_02_0008__b510mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="rms_02_0008__p512mcpsimp"><strong id="rms_02_0008__b513mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="rms_02_0008__p515mcpsimp"><strong id="rms_02_0008__b516mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row518mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p520mcpsimp">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p522mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p524mcpsimp">Specifies the resource ID.</p>
</td>
</tr>
<tr id="rms_02_0008__row525mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p527mcpsimp">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p529mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p531mcpsimp">Specifies the resource name.</p>
</td>
</tr>
<tr id="rms_02_0008__row532mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p534mcpsimp">provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p536mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p538mcpsimp">Specifies the cloud service name. For details, see <a href="rms_02_0019.html">Supported Resource</a>.</p>
</td>
</tr>
<tr id="rms_02_0008__row541mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p543mcpsimp">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p545mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p547mcpsimp">Specifies the resource type.</p>
</td>
</tr>
<tr id="rms_02_0008__row548mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p550mcpsimp">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p552mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p554mcpsimp">Specifies the region ID.</p>
</td>
</tr>
<tr id="rms_02_0008__row555mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p557mcpsimp">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p559mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p561mcpsimp">Specifies the project ID in OpenStack.</p>
</td>
</tr>
<tr id="rms_02_0008__row562mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p564mcpsimp">project_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p566mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p568mcpsimp">Specifies the project name in OpenStack.</p>
</td>
</tr>
<tr id="rms_02_0008__row569mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p571mcpsimp">ep_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p573mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p575mcpsimp">Specifies the enterprise project ID.</p>
</td>
</tr>
<tr id="rms_02_0008__row576mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p578mcpsimp">ep_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p580mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p582mcpsimp">Specifies the enterprise project name.</p>
</td>
</tr>
<tr id="rms_02_0008__row583mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p585mcpsimp">checksum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p587mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p589mcpsimp">Specifies the resource checksum.</p>
</td>
</tr>
<tr id="rms_02_0008__row590mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p592mcpsimp">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p594mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p596mcpsimp">Specifies the time when the resource was created.</p>
</td>
</tr>
<tr id="rms_02_0008__row597mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p599mcpsimp">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p601mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p603mcpsimp">Specifies the time when the resource was updated.</p>
</td>
</tr>
<tr id="rms_02_0008__row604mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p606mcpsimp">provisioning_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p608mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p610mcpsimp">Specifies the status of the operation that causes the resource change.</p>
</td>
</tr>
<tr id="rms_02_0008__row611mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p613mcpsimp">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p615mcpsimp">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p617mcpsimp">Specifies the resource tags.</p>
</td>
</tr>
<tr id="rms_02_0008__row618mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="rms_02_0008__p620mcpsimp">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="rms_02_0008__p622mcpsimp">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="rms_02_0008__p624mcpsimp">Specifies the detailed properties of the resource.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_02_0008____d0e2882"></a><a name="__d0e2882"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008____d0e2882" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Page Info</caption><thead align="left"><tr id="rms_02_0008__row631mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="rms_02_0008__p633mcpsimp"><strong id="rms_02_0008__b634mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="rms_02_0008__p636mcpsimp"><strong id="rms_02_0008__b637mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="rms_02_0008__p639mcpsimp"><strong id="rms_02_0008__b640mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row642mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="rms_02_0008__p644mcpsimp">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="rms_02_0008__p646mcpsimp">Number</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="rms_02_0008__p648mcpsimp">Specifies the resource quantity on the current page.</p>
<p id="rms_02_0008__p649mcpsimp">Minimum value: <strong id="rms_02_0008__b650mcpsimp">0</strong></p>
<p id="rms_02_0008__p651mcpsimp">Maximum value: <strong id="rms_02_0008__b652mcpsimp">200</strong></p>
</td>
</tr>
<tr id="rms_02_0008__row653mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="rms_02_0008__p655mcpsimp">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="rms_02_0008__p657mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="rms_02_0008__p659mcpsimp">Specifies the <strong id="rms_02_0008__b660mcpsimp">marker</strong> value of the next page.</p>
<p id="rms_02_0008__p558323224217">Minimum length: <strong id="rms_02_0008__b107922358426">4</strong></p>
<p id="rms_02_0008__p1358410322422">Maximum length: <strong id="rms_02_0008__b34829373422">400</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_02_0008__p661mcpsimp"><strong id="rms_02_0008__b662mcpsimp">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table663mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="rms_02_0008__row670mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="rms_02_0008__p672mcpsimp"><strong id="rms_02_0008__b673mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="rms_02_0008__p675mcpsimp"><strong id="rms_02_0008__b676mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="rms_02_0008__p678mcpsimp"><strong id="rms_02_0008__b679mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row681mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="rms_02_0008__p683mcpsimp">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="rms_02_0008__p685mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="rms_02_0008__p687mcpsimp">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_02_0008__row688mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="rms_02_0008__p690mcpsimp">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="rms_02_0008__p692mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="rms_02_0008__p694mcpsimp">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_02_0008__p695mcpsimp"><strong id="rms_02_0008__b696mcpsimp">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table697mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_02_0008__row704mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="rms_02_0008__p706mcpsimp"><strong id="rms_02_0008__b707mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="rms_02_0008__p709mcpsimp"><strong id="rms_02_0008__b710mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="rms_02_0008__p712mcpsimp"><strong id="rms_02_0008__b713mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row715mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="rms_02_0008__p717mcpsimp">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="rms_02_0008__p719mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="rms_02_0008__p721mcpsimp">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_02_0008__row722mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="rms_02_0008__p724mcpsimp">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="rms_02_0008__p726mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="rms_02_0008__p728mcpsimp">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_02_0008__p729mcpsimp"><strong id="rms_02_0008__b730mcpsimp">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table731mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="rms_02_0008__row738mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="rms_02_0008__p740mcpsimp"><strong id="rms_02_0008__b741mcpsimp">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="rms_02_0008__p743mcpsimp"><strong id="rms_02_0008__b744mcpsimp">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="rms_02_0008__p746mcpsimp"><strong id="rms_02_0008__b747mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row749mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="rms_02_0008__p751mcpsimp">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="rms_02_0008__p753mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="rms_02_0008__p755mcpsimp">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_02_0008__row756mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="rms_02_0008__p758mcpsimp">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="rms_02_0008__p760mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="rms_02_0008__p762mcpsimp">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_02_0008__section763mcpsimp"><h4 class="sectiontitle">Example Request</h4><ul id="rms_02_0008__ul765mcpsimp"><li id="rms_02_0008__li766mcpsimp">Querying all VMs under your account.<pre class="screen" id="rms_02_0008__screen1363095814114">GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudservers/resources</pre>
</li><li id="rms_02_0008__li768mcpsimp">Querying your VMs in the eu-de-04 region and setting to return the first 100 records.<pre class="screen" id="rms_02_0008__screen1669751834419">GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudservers/resources?limit=100&amp;region_id=eu-de</pre>
</li></ul>
</div>
<div class="section" id="rms_02_0008__section770mcpsimp"><h4 class="sectiontitle">Example Response</h4><p id="rms_02_0008__p772mcpsimp"><strong id="rms_02_0008__b773mcpsimp">Status code: 200</strong></p>
<p id="rms_02_0008__p774mcpsimp">Operation succeeded.</p>
<ul id="rms_02_0008__ul775mcpsimp"><li id="rms_02_0008__li776mcpsimp">Example 1<pre class="screen" id="rms_02_0008__screen32662191063"><span id="rms_02_0008__ph163016412713">{</span>
<span id="rms_02_0008__ph17312047715"> "current_count" : 2,</span>
<span id="rms_02_0008__ph123115419715"> "next_marker" : null</span>
<span id="rms_02_0008__ph16316414718"> }</span></pre>
</li><li id="rms_02_0008__li781mcpsimp">Example 2<pre class="screen" id="rms_02_0008__screen111015502614"><span id="rms_02_0008__ph1541949716">[ {</span>
<span id="rms_02_0008__ph3411749719"> "checksum" : "89ca775e88e04b2c200ccbf9e219ad0d7da42e3f446e5c953d443288134eec41",</span>
<span id="rms_02_0008__ph12421841470"> "created" : "2020-02-21T08:41:05Z",</span>
<span id="rms_02_0008__ph84217412717"> "ep_id" : "0",</span>
<span id="rms_02_0008__ph154284278"> "ep_name" : "default",</span>
<span id="rms_02_0008__ph14421846713"> "id" : "7ffd8564-d88a-4bc9-ab51-d8b79a57d0e6",</span>
<span id="rms_02_0008__ph742748712"> "name" : "vpc-489c",</span>
<span id="rms_02_0008__ph204214420719"> "project_id" : "059b5e0a2500d5552fa1c00adada8c06",</span>
<span id="rms_02_0008__ph1243154671"> "project_name" : "eu-de-07",</span>
<span id="rms_02_0008__ph24364975"> "properties" : {</span>
<span id="rms_02_0008__ph15441341578"> "cidr" : "192.168.0.0/16",</span>
<span id="rms_02_0008__ph13441141277"> "status" : "OK"</span>
<span id="rms_02_0008__ph1644144674"> },</span>
<span id="rms_02_0008__ph84454874"> "provider" : "vpc",</span>
<span id="rms_02_0008__ph744134376"> "provisioning_state" : "Succeeded",</span>
<span id="rms_02_0008__ph444741274"> "region_id" : "eu-de-07",</span>
<span id="rms_02_0008__ph154518419713"> "tags" : {</span>
<span id="rms_02_0008__ph4452415713"> "use" : "test"</span>
<span id="rms_02_0008__ph17451148715"> },</span>
<span id="rms_02_0008__ph74511418711"> "type" : "vpcs",</span>
<span id="rms_02_0008__ph1645114474"> "updated" : "2020-02-21T08:41:05Z"</span>
<span id="rms_02_0008__ph84612417711"> }, {</span>
<span id="rms_02_0008__ph1461648710"> "checksum" : "db2aad42804951c03a724b7501da9b6b4c14d319dd319d76bb7c658f256a37b0",</span>
<span id="rms_02_0008__ph646144674"> "created" : "2020-02-24T08:43:05Z",</span>
<span id="rms_02_0008__ph13461245715"> "ep_id" : "0",</span>
<span id="rms_02_0008__ph1146148710"> "ep_name" : "default",</span>
<span id="rms_02_0008__ph114612412715"> "id" : "b63b33b7-f48c-4048-995b-0445d124a445",</span>
<span id="rms_02_0008__ph1846345718"> "name" : "VPC_TEST3_20200224163856",</span>
<span id="rms_02_0008__ph34744878"> "project_id" : "059b5e0a2500d5552fa1c00adada8c06",</span>
<span id="rms_02_0008__ph947540715"> "project_name" : "eu-de-07",</span>
<span id="rms_02_0008__ph1047841716"> "properties" : {</span>
<span id="rms_02_0008__ph6473413717"> "cidr" : "192.168.0.0/16",</span>
<span id="rms_02_0008__ph3474411718"> "status" : "OK"</span>
<span id="rms_02_0008__ph1247204072"> },</span>
<span id="rms_02_0008__ph1048241971"> "provider" : "vpc",</span>
<span id="rms_02_0008__ph154815415710"> "provisioning_state" : "Succeeded",</span>
<span id="rms_02_0008__ph144815420714"> "region_id" : "eu-de-07",</span>
<span id="rms_02_0008__ph12483415714"> "tags" : {</span>
<span id="rms_02_0008__ph448541179"> "use" : "test1"</span>
<span id="rms_02_0008__ph3481241972"> },</span>
<span id="rms_02_0008__ph948241715"> "type" : "vpcs",</span>
<span id="rms_02_0008__ph11491441710"> "updated" : "2020-08-11T11:55:08Z"</span>
<span id="rms_02_0008__ph1649134079"> } ]</span></pre>
</li></ul>
</div>
<div class="section" id="rms_02_0008__section825mcpsimp"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_02_0008__table827mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_02_0008__row832mcpsimp"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="rms_02_0008__p834mcpsimp"><strong id="rms_02_0008__b835mcpsimp">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="rms_02_0008__p837mcpsimp"><strong id="rms_02_0008__b838mcpsimp">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rms_02_0008__row840mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="rms_02_0008__p842mcpsimp">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="rms_02_0008__p844mcpsimp">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_02_0008__row845mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="rms_02_0008__p847mcpsimp">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="rms_02_0008__p849mcpsimp">Invalid parameter.</p>
</td>
</tr>
<tr id="rms_02_0008__row850mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="rms_02_0008__p852mcpsimp">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="rms_02_0008__p854mcpsimp">Authentication failed.</p>
</td>
</tr>
<tr id="rms_02_0008__row855mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="rms_02_0008__p857mcpsimp">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="rms_02_0008__p859mcpsimp">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_02_0008__section860mcpsimp"><h4 class="sectiontitle">Error Codes</h4><p id="rms_02_0008__p862mcpsimp">See <a href="rms_02_0018.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_02_0007.html">Resource Query</a></div>
</div>
</div>
View Git Blame Copy Permalink