doc-exports/docs/config/api-ref/rms_04_0601.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

291 lines
19 KiB
HTML

<a name="rms_04_0601"></a><a name="rms_04_0601"></a>
<h1 class="topictitle1">Querying Regions Visible to You</h1>
<div id="body15652164019613"><div class="section" id="rms_04_0601__section1465214401060"><h4 class="sectiontitle">Function</h4><p id="rms_04_0601__p186538408615">This API is used to query regions visible to you.</p>
</div>
<div class="section" id="rms_04_0601__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0601__p36541040368">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
</div>
<div class="section" id="rms_04_0601__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0601__p1165511400620">GET /v1/resource-manager/domains/{domain_id}/regions</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__table186564406615" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="rms_04_0601__row16551540362"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="rms_04_0601__p116575401468">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_0601__p1265720401164">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_0601__p165818401065">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_0601__p1658140862">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row15656134015611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0601__p1765814401613">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0601__p116593404612">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0601__p166597408612">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0601__p116608408612">Specifies tags.</p>
<p id="rms_04_0601__p1066054014615">Maximum: <strong id="rms_04_0601__b106611040161">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0601__section206621540961"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0601__row4662114015619"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0601__p066417401965">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_0601__p1966464010616">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_0601__p186651440562">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_0601__p266520405615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row1966217401469"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0601__p1766516402615">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0601__p146663400614">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0601__p96661407617">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0601__p8217721115915">Language of the returned message.</p>
<p id="rms_04_0601__p834520331955">Default: <strong id="rms_04_0601__b1943184110512">en-us</strong></p>
</td>
</tr>
<tr id="rms_04_0601__row146636401567"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0601__p2668164015616">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_0601__p1566918401619">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0601__p136696409613">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0601__p56694401167">Specifies the invoker's token.</p>
</td>
</tr>
<tr id="rms_04_0601__row36635401568"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0601__p1670144019617">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_0601__p867017402620">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0601__p14671114020611">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0601__p1867116400619">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_0601__section14672194017611"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0601__p19672240864"><strong id="rms_04_0601__b1667316401367">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__response_RegionListResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0601__row567313406616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0601__p7674164018618">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_0601__p2067594011617">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_0601__p36754408617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row13673840662"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0601__p176759407613">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0601__p7676194014613">Array of <a href="#rms_04_0601__response_Region">Region</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0601__p467714401261">Specifies the list of region information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0601__response_Region"></a><a name="response_Region"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__response_Region" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Region</caption><thead align="left"><tr id="rms_04_0601__row7678174020613"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="rms_04_0601__p167920401969">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_0601__p116794407618">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_0601__p96804409611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row126781340867"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0601__p36806401169">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0601__p7681104014612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0601__p368115401164">Specifies the region ID.</p>
</td>
</tr>
<tr id="rms_04_0601__row4678840560"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0601__p46824405611">display_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0601__p46823409617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0601__p176822405617">Specifies the display name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0601__p468314407610"><strong id="rms_04_0601__b106834401613">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0601__row36845408618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="rms_04_0601__p2068564020610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="rms_04_0601__p196862401763">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="rms_04_0601__p206861940761">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row18684340861"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0601__p16687540361">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0601__p18687124015612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0601__p18688040566">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0601__row196847408618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0601__p14688240262">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0601__p5688174011612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0601__p96896402617">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0601__p186894401661"><strong id="rms_04_0601__b1569011404611">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__response_ErrorResp_1" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0601__row869010401768"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="rms_04_0601__p269115404619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="rms_04_0601__p106931940968">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="rms_04_0601__p1869412407611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row20690174014614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="rms_04_0601__p1669412408617">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="rms_04_0601__p36949401160">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="rms_04_0601__p06952401763">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0601__row15690124011619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="rms_04_0601__p176951840163">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="rms_04_0601__p1869617401361">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="rms_04_0601__p1696640167">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0601__p0697640663"><strong id="rms_04_0601__b1697104019618">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__response_ErrorResp_2" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0601__row16984404619"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p id="rms_04_0601__p1369974012613">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.2"><p id="rms_04_0601__p670084019612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.10.2.4.1.3"><p id="rms_04_0601__p770020401662">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row66989401161"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="rms_04_0601__p270113401866">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="rms_04_0601__p670213403617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="rms_04_0601__p770244011610">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0601__row166982404613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="rms_04_0601__p17703144011617">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="rms_04_0601__p17703040963">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="rms_04_0601__p1970412401266">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0601__p197046409611"><strong id="rms_04_0601__b470420401616">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__response_ErrorResp_3" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0601__row470514405610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="rms_04_0601__p167061440361">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p id="rms_04_0601__p10706134017617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p id="rms_04_0601__p7707134015620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row157059404612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="rms_04_0601__p7707340860">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="rms_04_0601__p27083401369">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="rms_04_0601__p27080401611">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0601__row270594011617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="rms_04_0601__p97099401764">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="rms_04_0601__p177107401264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="rms_04_0601__p157114401466">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0601__section117121240469"><h4 class="sectiontitle">Example Requests</h4><p id="rms_04_0601__p1971304010616">None</p>
</div>
<div class="section" id="rms_04_0601__section27137402061"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0601__p12713140160"><strong id="rms_04_0601__b37141340865">Status code: 200</strong></p>
<p id="rms_04_0601__p2714540665">Operation succeeded.</p>
<pre class="screen" id="rms_04_0601__screen1171564016614">{
"value" : [ {
"region_id" : "regionid1",
"display_name" : "region1"
}, {
"region_id" : "regionid2",
"display_name" : "region2"
} ]
}</pre>
</div>
<div class="section" id="rms_04_0601__section166410411264"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0601__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0601__row187581740967"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0601__p06417418611">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_0601__p1264213411560">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0601__row1775817405613"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0601__p13642104112618">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0601__p126420415612">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_04_0601__row4759540467"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0601__p1464294120615">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0601__p11642741663">Invalid parameters.</p>
</td>
</tr>
<tr id="rms_04_0601__row16759940268"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0601__p96421541167">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0601__p1364210416613">User authentication failed.</p>
</td>
</tr>
<tr id="rms_04_0601__row1075911403611"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0601__p4643164114617">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0601__p36434419610">User not found.</p>
</td>
</tr>
<tr id="rms_04_0601__row775916405611"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0601__p106432041761">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0601__p26432417617">Server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0601__section12643104111618"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0601__p1464318411164">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_0600.html">Region Management</a></div>
</div>
</div>