vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/config/api-ref/rms_04_0104.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

527 lines
34 KiB
HTML
Raw Blame History

<a name="rms_04_0104"></a><a name="rms_04_0104"></a>
<h1 class="topictitle1">Querying All Resources Under Your Account</h1>
<div id="body12821145912373"><div class="section" id="rms_04_0104__section208214598379"><h4 class="sectiontitle">Function</h4><p id="rms_04_0104__p48221859183715">This API is used to query all resources under your account and you must have the **rms:resources:list **permission.</p>
</div>
<div class="section" id="rms_04_0104__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0104__p198221559133713">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
</div>
<div class="section" id="rms_04_0104__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0104__p1382312591373">GET /v1/resource-manager/domains/{domain_id}/all-resources</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__table1582416592379" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="rms_04_0104__row188231359173713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="rms_04_0104__p9824115914372">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_0104__p10824135963712">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_0104__p58251559173711">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_0104__p08258597376">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row1082455923720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0104__p9825359143720">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0104__p1982555917377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0104__p8826185918373">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0104__p198261159103714">Specifies tags.</p>
<p id="rms_04_0104__p1882665933711">Maximum: <strong id="rms_04_0104__b1826145913376">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__table11829559163717" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="rms_04_0104__row13827205923713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="rms_04_0104__p1282919593372">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_0104__p1082945913711">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_0104__p9830205914377">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_0104__p1783019591375">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row882705912371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p1783012591376">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p17831159133715">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p58311759113714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p2831145933711">Specifies the region ID.</p>
<p id="rms_04_0104__p18321659133710">Maximum: <strong id="rms_04_0104__b0832559203715">36</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row3827135963715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p168328592374">ep_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p1283275993717">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p183355916375">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p0833115916378">Specifies the enterprise project ID.</p>
<p id="rms_04_0104__p1383345943710">Maximum: <strong id="rms_04_0104__b583316595375">36</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row118271559103711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p18833759163714">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p5834159133710">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p8834155973713">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p17834145915379">Specifies the resource type in the format of <strong id="rms_04_0104__b12834125910377">provider.type</strong>.</p>
<p id="rms_04_0104__p48341959183715">Maximum: <strong id="rms_04_0104__b0835959113716">40</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row16828125917374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p08351259133714">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p15835185953716">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p1183513596377">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p178354597375">Specifies the maximum number of resources to return.</p>
<p id="rms_04_0104__p158364596371">Minimum: <strong id="rms_04_0104__b1483675920373">1</strong></p>
<p id="rms_04_0104__p38361859173712">Maximum: <strong id="rms_04_0104__b158361359103710">200</strong></p>
<p id="rms_04_0104__p58371759113713">Default: <strong id="rms_04_0104__b983716590372">100</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row6828135973711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p198373595376">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p18838115914374">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p1783875920378">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p11838195913713">Specifies the pagination parameter.</p>
<p id="rms_04_0104__p178381959133712">Minimum: <strong id="rms_04_0104__b88396598376">4</strong></p>
<p id="rms_04_0104__p28399598375">Maximum: <strong id="rms_04_0104__b16839165915378">400</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row10828165953715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p683918595372">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p1983917594371">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p18840115953718">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p284045920373">Specifies the resource ID.</p>
<p id="rms_04_0104__p188401859183712">Maximum: <strong id="rms_04_0104__b16841115963715">512</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row15828259133712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p084185912375">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p18410595379">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p1084225917378">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p19842759183710">Specifies the resource name.</p>
<p id="rms_04_0104__p1384255973716">Maximum: <strong id="rms_04_0104__b684215599370">256</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row782819595378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="rms_04_0104__p384335953711">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="rms_04_0104__p108431259173712">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="rms_04_0104__p2843135911373">Array</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="rms_04_0104__p6843359163710">Specifies tags. The format is <strong id="rms_04_0104__b184310597376">key</strong> or <strong id="rms_04_0104__b2843155993717">key=value</strong>.</p>
<p id="rms_04_0104__p3843959113718">Array Length: <strong id="rms_04_0104__b14844145973711">1 - 5</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0104__section13844359143717"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0104__row13844105919379"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0104__p7845759123714">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_0104__p1784516593378">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_0104__p78468599379">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_0104__p98466599379">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row1384419592376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0104__p1284645917370">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_0104__p1984665983711">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0104__p1884745920372">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0104__p14847205914372">Specifies the invoker's token.</p>
</td>
</tr>
<tr id="rms_04_0104__row284585917377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0104__p1884785917376">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_0104__p198471359173711">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0104__p184795911374">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0104__p1284895912377">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_0104__section1084895911374"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0104__p1848159163714"><strong id="rms_04_0104__b68482595370">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__response_ResourceListResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0104__row8849195963713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0104__p7850145963710">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_0104__p7850135913372">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_0104__p28501559163714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row8849459153712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0104__p11851185910371">resources</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0104__p685145915379">Array of <a href="#rms_04_0104__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_0104__p685117594373">Specifies the resource list.</p>
</td>
</tr>
<tr id="rms_04_0104__row128491559123718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0104__p28527592378">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0104__p1085265912378"><a href="#rms_04_0104__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_0104__p10852145943718">Specifies the pagination object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0104__response_ResourceEntity"></a><a name="response_ResourceEntity"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__response_ResourceEntity" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResourceEntity</caption><thead align="left"><tr id="rms_04_0104__row185445953712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="rms_04_0104__p18857195911378">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_0104__p19857195913713">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_0104__p685755963713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row10854105910378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p12857165943714">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p2858259123717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p178581259123713">Specifies the resource ID.</p>
</td>
</tr>
<tr id="rms_04_0104__row18854125919371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p785885953718">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p15858759113712">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p1385945933710">Specifies the resource name.</p>
</td>
</tr>
<tr id="rms_04_0104__row585415591376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p168596591378">provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p138598593371">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p986085918374">Specifies the cloud service name.</p>
</td>
</tr>
<tr id="rms_04_0104__row885465993713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p5860165912377">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p3860175914374">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p68601259113719">Specifies the resource type.</p>
</td>
</tr>
<tr id="rms_04_0104__row108551959193714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p586155911378">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p1186135913711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p1861185919379">Specifies the region ID.</p>
</td>
</tr>
<tr id="rms_04_0104__row2855105914377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p986116593374">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p1286225963715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p9862125918372">Specifies the project ID in IaaS OpenStack.</p>
</td>
</tr>
<tr id="rms_04_0104__row185514592374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p19862115915377">project_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p1786285911372">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p5863759133718">Specifies the project name in IaaS OpenStack.</p>
</td>
</tr>
<tr id="rms_04_0104__row2085555911373"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p5863175983710">ep_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p7863459153711">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p686310598375">Specifies the enterprise project ID.</p>
</td>
</tr>
<tr id="rms_04_0104__row2855115923719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p16864145973717">ep_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p10864259143717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p17864175913371">Specifies the name of an enterprise project.</p>
</td>
</tr>
<tr id="rms_04_0104__row208551259133716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p198652598372">checksum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p17865659103717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p1886511596372">Specifies the resource checksum.</p>
</td>
</tr>
<tr id="rms_04_0104__row58551759183716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p9866155933717">created</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p586685943716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p128669591371">Specifies the time when the resource was created.</p>
</td>
</tr>
<tr id="rms_04_0104__row1885535910379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p48673592371">updated</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p28671459113710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p1386715918374">Specifies the time when the resource was updated.</p>
</td>
</tr>
<tr id="rms_04_0104__row2855359123712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p88681659123713">provisioning_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p586813599372">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p6868105911372">Specifies the status of a resource operation.</p>
</td>
</tr>
<tr id="rms_04_0104__row12856459143714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p188682592374">state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p7869859183717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0104__p1886925918377">Resource state. The value can be normal or deleted.</p>
</td>
</tr>
<tr id="rms_04_0104__row1985614595378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p1686918593377">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p1986918595374">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_0104__p886995919378">Specifies the resource tag.</p>
</td>
</tr>
<tr id="rms_04_0104__row685605917375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0104__p138701459163716">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0104__p9870135933710">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_0104__p188701459113719">Specifies the detailed properties of the resource.</p>
<p id="rms_04_0104__p1537132891715">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_0104__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PageInfo</caption><thead align="left"><tr id="rms_04_0104__row487125917373"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="rms_04_0104__p787265919378">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_0104__p1287216590370">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_0104__p1687285943718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row287175913713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0104__p9873125914375">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0104__p487345973712">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0104__p13873185933714">Specifies the resource quantity on the current page.</p>
<p id="rms_04_0104__p8873195983713">Minimum: <strong id="rms_04_0104__b1187405953717">0</strong></p>
<p id="rms_04_0104__p2874759173712">Maximum: <strong id="rms_04_0104__b18874159103712">200</strong></p>
</td>
</tr>
<tr id="rms_04_0104__row4871359193715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0104__p387410597377">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0104__p5875115919378">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0104__p4875105913372">Specifies the <strong id="rms_04_0104__b0875195943717">marker</strong> value of the next page.</p>
<p id="rms_04_0104__p12875195943713">Minimum: <strong id="rms_04_0104__b6875559183713">4</strong></p>
<p id="rms_04_0104__p118754596373">Maximum: <strong id="rms_04_0104__b38761959103712">400</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0104__p187615597374"><strong id="rms_04_0104__b1287665912371">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0104__row1387616597379"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="rms_04_0104__p1587815591376">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_0104__p08781159113716">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_0104__p128788593373">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row8876105923719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0104__p587935973715">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0104__p1987916599375">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0104__p7879205911372">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0104__row98773599374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0104__p1187935943713">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0104__p2880135913370">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0104__p1788011599372">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0104__p12880135993716"><strong id="rms_04_0104__b1988065917377">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__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_0104__row1188117593375"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="rms_04_0104__p138821159203720">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_0104__p18882859113716">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_0104__p10882165910373">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row18881115973717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0104__p4882135913715">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0104__p11883105916379">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0104__p188375910373">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0104__row128816592379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0104__p11883135993717">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0104__p4883195912376">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0104__p11883105916376">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0104__p688385919376"><strong id="rms_04_0104__b18884195943719">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__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_0104__row13884165903711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="rms_04_0104__p1188513592372">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_0104__p1886195913715">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_0104__p288620593374">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row98849591379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0104__p688685983711">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0104__p178871659143720">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0104__p2887135920379">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0104__row1588417593370"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0104__p138871959163718">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0104__p10888135913715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0104__p15888759163716">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0104__section16888359123716"><h4 class="sectiontitle">Example Requests</h4><ul id="rms_04_0104__ul17963019383"><li id="rms_04_0104__li15962006381">Querying all resources under your account<pre class="screen" id="rms_04_0104__screen189616063817">GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/all-resources</pre>
</li><li id="rms_04_0104__li1096120163820">Querying your resources in the <strong id="rms_04_0104__b5961503380">default</strong> enterprise project and setting to return the first 100 records<pre class="screen" id="rms_04_0104__screen6962023813">GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/all-resources?limit=100&amp;ep_id=0</pre>
</li></ul>
</div>
<div class="section" id="rms_04_0104__section139690193813"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0104__p159613023817"><strong id="rms_04_0104__b396140133816">Status code: 200</strong></p>
<p id="rms_04_0104__p13976019385">Operation succeeded.</p>
<pre class="screen" id="rms_04_0104__screen1597180203815">{
"resources" : [ {
"id" : "3ccd9191-6a5e-4939-a971-4652db18b370",
"name" : "elb-265a",
"provider" : "elb",
"type" : "loadbalancers",
"region_id" : "regionid1",
"project_id" : "05498e12458025102ff5c0061a584a9f",
"project_name" : "regionid1_region_service",
"ep_id" : "0",
"ep_name" : "default",
"checksum" : "6e0271b107b764b19acb235f45c0d852f72104fe1d4b32970686e7eae8e87bf4",
"created" : "2020-02-29T09:39:19Z",
"updated" : "2020-02-29T09:39:19Z",
"provisioning_state" : "Succeeded",
"tags" : { },
"properties" : {
"tenant_id" : "05498e12458025102ff5c0061a584a9f",
"listeners" : [ {
"id" : "37de3be0-1803-43e2-9bb5-243b4b30b771"
} ],
"provisioning_status" : "ACTIVE",
"description" : ""
}
}, {
"id" : "a6e56d05501944d3b2507ba506a43744",
"name" : "console",
"provider" : "cdn",
"type" : "domains",
"region_id" : "global",
"project_id" : "",
"project_name" : "",
"ep_id" : "0",
"ep_name" : "default",
"checksum" : "56afa8b76428f90e9abfbe5cbf33535d8816166114d32eeb119658d6c59eceda",
"created" : "2020-01-04T13:42:37Z",
"updated" : "2020-01-15T04:23:01Z",
"provisioning_state" : "Succeeded",
"tags" : { },
"properties" : {
"domain_name" : "console",
"domain_status" : "offline",
"business_type" : "WEB",
"modify_time" : 1579062181463,
"cname" : "console"
}
} ],
"page_info" : {
"current_count" : 2,
"next_marker" : null
}
}</pre>
</div>
<div class="section" id="rms_04_0104__section12102130193814"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0104__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0104__row1791917596371"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0104__p1710211010387">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_0104__p110214014385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0104__row119191459133711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0104__p2010216020387">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0104__p151021901381">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_04_0104__row2920105911374"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0104__p31029083813">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0104__p310318093814">Invalid parameters.</p>
</td>
</tr>
<tr id="rms_04_0104__row1292045913710"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0104__p1210330113811">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0104__p3103006388">User Authentication failed.</p>
</td>
</tr>
<tr id="rms_04_0104__row189201059153713"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0104__p81031308382">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0104__p71038013381">Server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0104__section12103907386"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0104__p1910318016388">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