forked from docs/doc-exports
weihongmin1
46d24ba358
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: weihongmin1 <weihongmin1@huawei.com> Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
346 lines
26 KiB
HTML
346 lines
26 KiB
HTML
<a name="en-us_topic_0067148043"></a><a name="en-us_topic_0067148043"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Region List</h1>
|
|
<div id="body1500449320395"><div class="section" id="en-us_topic_0067148043__s1fea94fc86654d20a4264b290de6701b"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0067148043__p148335515412">This API is used to query a region list.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148043__sd0c6621b74af445d8e95f2e8c5061c96"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0067148043__p60548132171948">GET /v3/regions</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148043__sc6a67a265e0c4e6c85c6dddbfffeec05"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0067148043__u1d3947ed86684f15b247b7f85ff13e49"><li id="en-us_topic_0067148043__l6d0e380a90d345d1a6fc4da81b881634">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__t97020ff6a99b4d02897c62dc32176b10" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__r33f9811ab31441bcbb68da4318582ff7"><th align="left" class="cellrowborder" valign="top" width="20.3020302030203%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0067148043__a15b20b8a2b1a4846942c4381d69d0f1f">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.421842184218423%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0067148043__a0c341246324648c2a331a2f3b29728ce">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.2019201920192%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0067148043__ae3c49c667f304a8ea41ef4821a55dd34">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.07420742074208%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0067148043__ac65744bcbe944be4891ed74be82742a6">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__rd59aad8dd3584169840a2a50ca0bc035"><td class="cellrowborder" valign="top" width="20.3020302030203%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148043__a5f8f06a2f0f141d1b14d88d3cec03e26">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148043__a0c8ab11defdf4c8f817b21b21680e919">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.2019201920192%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148043__a222d884836b34d4b96111de13ad02311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.07420742074208%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148043__af58e489f66734ee8bfea4223431362ec">Fill <strong id="en-us_topic_0067148043__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__red29555edeb84300a63e22cdf504909a"><td class="cellrowborder" valign="top" width="20.3020302030203%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148043__a41b44a08aca64e4382a1901f5c4d384d">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148043__a554d5f30caf14006ba608ee5e933804c">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.2019201920192%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148043__aa734bd6d2ee44712b9b1fba893b1ea79">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.07420742074208%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148043__a3598b3c82d4745f18c1f204cf8097e6d">Authenticated token. If the token does not contain the private region information, the system does not return the private region in the query result.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148043__l203797174d05411c8b00a37fc553402c">Example request<pre class="screen" id="en-us_topic_0067148043__s8023a0f3e27d49229da33bb33babebc3"><em id="en-us_topic_0067148043__i01061551111911">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/regions</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148043__s6166214bb04d407290d8691550229884"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0067148043__u1aa83966165e447ab29831655fe9c29c"><li id="en-us_topic_0067148043__ld0e3569b57e24cc08be0e44a39cc34d7">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__tb910705b0d224d4b865a2a380e18ba5d" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__rce437c54628e460888b9e36e38807daf"><th align="left" class="cellrowborder" valign="top" width="20.612061206120615%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0067148043__ac3d9a9532a2a4e4e8fb323e49d404a2b">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.981798179817982%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0067148043__a36bd4c1abede4c8994e271a4e2359094">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.171917191719174%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0067148043__a64b48b3e02b741239ddeb461da7b80a7">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.23422342234223%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0067148043__a30ed7f27fe694d6cb3f93de39adca161">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__r25eb5eb273bd4ced8e3122d43850c0e1"><td class="cellrowborder" valign="top" width="20.612061206120615%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148043__a9146880c74894fcd9d8eb2d2c98c370a"><a href="#en-us_topic_0067148043__li13463758160">links</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.981798179817982%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148043__a1f16deaf10eb42bc9e7a4593b24ecd02">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.171917191719174%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148043__a489d4c326f6b4e889bc802b62aafe32b">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.23422342234223%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148043__ac514ce1e4fe441b989345cc9facdb55f">Region resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__r242e991826e14b1dade4ba266058e55b"><td class="cellrowborder" valign="top" width="20.612061206120615%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148043__a61cfaadb79a141ef80c86a0cd8bd433e"><a href="#en-us_topic_0067148043__li2129719204">regions</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.981798179817982%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148043__a7cfc068a0c9840b091c82099eccf830c">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.171917191719174%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148043__afbf6dbb3fa4a42bd8a7273c111694719">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.23422342234223%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148043__ac2e443e20612470ca0bd0e578b1ccd82">Region list.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148043__li2129719204"><a name="en-us_topic_0067148043__li2129719204"></a><a name="li2129719204"></a>regions
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__tb2bf5558b31c40f1b23ddb90344694ed" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__rf5b1f53927094b209775f3a30a9688ad"><th align="left" class="cellrowborder" valign="top" width="20.31%" id="mcps1.3.4.2.2.1.1.4.1.1"><p id="en-us_topic_0067148043__a50cf8893ff5b466994dcb32ddc486532">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.4.2.2.1.1.4.1.2"><p id="en-us_topic_0067148043__a17a76f276add4aaf96a726f84ba8970b">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.099999999999994%" id="mcps1.3.4.2.2.1.1.4.1.3"><p id="en-us_topic_0067148043__a0dfe4c5bbc2341779ea07634c816918e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__r5f2be5855ed44ceda1ced8ce52b917af"><td class="cellrowborder" valign="top" width="20.31%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="en-us_topic_0067148043__a948ef1f615e8436386bce5dc4a9c6558">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="en-us_topic_0067148043__ac667b1978bcc4cf8877188051da52faf">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.099999999999994%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="en-us_topic_0067148043__ab20d96dbde5e4a5b88827afaf59d41ed">Region description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__rf433087c91364b65a0999296f6750a89"><td class="cellrowborder" valign="top" width="20.31%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="en-us_topic_0067148043__a27c9a64e7ff0456c9d9e5c7a4b7e4dce">parent_region_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="en-us_topic_0067148043__ac169f6e7e5e546e5afb535ec1be016c7">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.099999999999994%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="en-us_topic_0067148043__a0b1e82ff5b27487883d9c5a430a7deaf">Parent region ID of a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__rd8ce5aab53784b0a9c474163a677d8b8"><td class="cellrowborder" valign="top" width="20.31%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="en-us_topic_0067148043__af57c718a55bb44babae7652dca19dcd3">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="en-us_topic_0067148043__a3933000b9f6a468ebbdcd7d485575bf4">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.099999999999994%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="en-us_topic_0067148043__a15fb8acbca5f4befa9d3a285d6636ea3">Region ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__r5b8f27117c424bcba12dad424daed5ae"><td class="cellrowborder" valign="top" width="20.31%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="en-us_topic_0067148043__a56c40ed10d40453996252a2db888371a"><a href="#en-us_topic_0067148043__li6783209973">locales</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="en-us_topic_0067148043__a253711d5d5b746ab869f4ace3cde5e46">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.099999999999994%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="en-us_topic_0067148043__a27379a7b72cb4e7fb9c30beafc541df7">Region name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__r479ea6215d4f4946a2381c5a6fedceb8"><td class="cellrowborder" valign="top" width="20.31%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="en-us_topic_0067148043__aa1e55dcd63ef459588d16f6231b3aaae">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="en-us_topic_0067148043__a61174ff0d9194122890eeff8444d9bbd">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.099999999999994%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="en-us_topic_0067148043__af72ea144ce8b4cc4b0b53e7889078762">Region type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__raf37fde9b2e2495d869109bb4667724a"><td class="cellrowborder" valign="top" width="20.31%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="en-us_topic_0067148043__ad5fbea32d9f642fcb442c5689c79c876"><a href="#en-us_topic_0067148043__li11493001976">links</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="en-us_topic_0067148043__af54a16806cc94b718d0107302ac9b87a">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.099999999999994%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="en-us_topic_0067148043__a550ac0e18c9942f4b6c7bfcc42f820ac">Region resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148043__li13463758160"><a name="en-us_topic_0067148043__li13463758160"></a><a name="li13463758160"></a>links
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__en-us_topic_0221482446_response_Rs51Links" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__en-us_topic_0221482446_row163099612378"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.3.1.1.4.1.1"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p193103623715">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.3.1.1.4.1.2"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p17310196103713">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.3.1.1.4.1.3"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1231115619370">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__en-us_topic_0221482446_row4309186123711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1311666373">self</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p33121666372">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p53123613377">Resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0221482446_row193091966374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1131310603712">previous</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p16313126193718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1431410693713">Previous resource link. If the previous resource link is unavailable, this parameter is set to <strong id="en-us_topic_0067148043__b1821218168">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0221482446_row13095615371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p131426203720">next</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p11315126183711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p431516123710">Next resource link. If the next resource link is unavailable, this parameter is set to <strong id="en-us_topic_0067148043__b1819813401963">null</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148043__li11493001976"><a name="en-us_topic_0067148043__li11493001976"></a><a name="li11493001976"></a>regions.links
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__en-us_topic_0221482446_response_Rs51RegionsArritemLinks" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__en-us_topic_0221482446_row113281615372"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.4.1.1.4.1.1"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p932812613711">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.4.1.1.4.1.2"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p5329176153716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.4.1.1.4.1.3"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p113293619375">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__en-us_topic_0221482446_row032814693713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p133307643720">self</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1733026143718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.4.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p43311263378">Resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148043__li6783209973"><a name="en-us_topic_0067148043__li6783209973"></a><a name="li6783209973"></a>regions.locales
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__en-us_topic_0221482446_response_Rs51RegionsArritemLocales" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__en-us_topic_0221482446_row1533218663716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.5.1.1.4.1.1"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p933211693716">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.5.1.1.4.1.2"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p8333176183716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.5.1.1.4.1.3"><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1833336173716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__en-us_topic_0221482446_row193320693712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p193354613719">en-us</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1933613618379">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.5.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1833696203718">Region name in English.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0221482446_row1133296123719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p12337869378">pt-br</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p5337126183710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.5.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p633810683714">Region name in Portuguese.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0221482446_row33321760379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p143389683719">es-us</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p63391618373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.5.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p8339156173713">Region name in Spanish (Latin American).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0221482446_row433215610371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p15340462379">es-es</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p1734036183713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.5.1.1.4.1.3 "><p id="en-us_topic_0067148043__en-us_topic_0221482446_p143418653718">Region name in Spanish (Spain).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148043__li19818548164113">Example response (successful response)<pre class="screen" id="en-us_topic_0067148043__screen118181648174111">{
|
|
"regions": [
|
|
{
|
|
"parent_region_id": null,
|
|
"description": "",
|
|
"links": {
|
|
"self": "None/v3/regions/1500365963661574434"
|
|
},
|
|
"type": "private",
|
|
"id": "1500365963661574434",
|
|
"locales": {
|
|
|
|
"en-us": "<em id="en-us_topic_0067148043__i119371009434">region_name2</em>"
|
|
}
|
|
},
|
|
{
|
|
"parent_region_id": null,
|
|
"description": "",
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/regions/500017826026667755"
|
|
},
|
|
"type": "private",
|
|
"id": "500017826026667755",
|
|
"locales": {
|
|
|
|
"en-us": "<em id="en-us_topic_0067148043__i4315750494618">region_name2</em>"
|
|
}
|
|
},
|
|
{
|
|
"parent_region_id": null,
|
|
"description": "",
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/regions/<em id="en-us_topic_0067148043__i44172413102431">region_name</em>"
|
|
},
|
|
"type": "public",
|
|
"id": "test2",
|
|
"locales": {
|
|
|
|
"en-us": "<em id="en-us_topic_0067148043__i3992529694648">region_name2</em>"
|
|
}
|
|
},
|
|
{
|
|
"parent_region_id": null,
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/regions/test1112244"
|
|
},
|
|
"id": "test1112244",
|
|
"locales": {
|
|
|
|
"en-us": "testregion1"
|
|
},
|
|
"description": ""
|
|
}
|
|
],
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/regions",
|
|
"previous": null,
|
|
"next": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148043__se70eb4ec1a7c43ec9858561956f0a7ba"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148043__en-us_topic_0035544336_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148043__en-us_topic_0035544336_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0067148043__en-us_topic_0035544336_p51565323">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0067148043__en-us_topic_0035544336_p16041657">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148043__en-us_topic_0035544336_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0035544336_p22613965">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0035544336_p19791876">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0035544336_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0035544336_p66980994">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__en-us_topic_0035544336_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__rb99fbab78bc54ae4953661763b573830"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__aef55745ff0834933af36d690e2e339b8">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__a480215738ced4bf5a8feafa2681db93b">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__en-us_topic_0035544336_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__en-us_topic_0035544336_p32717189">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__ae678037f26d640f5a985c943e2ffb92e">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__r1fd5c05b7b6b4c048f3f7b9ddbc755b0"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__a5d7e2305922e4f9098442a900792dae1">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__a9edf299d0513460caaac8a2a19b76e9a">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__rbb5133f150fd42eebde8dd6e390ecbd5"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__ad1a2754016e44193a97043265cd611cf">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__a81837d461ef445259c5a6e9e1ce0e32a">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__r2cecff297b1a412f956a312d3cd7acc9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__a1f617621d1bc4a9facb1c84d1946002b">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__ac31ead3ee2db40eea8ae45b2779a09e9">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__rd71e0e00759f4179a2dccaf345ba9f2f"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__a1657c5ca5ebd4a2cbacbdb35fc9b7601">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__a88b4b14048564e12942b8151dc791b99">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148043__r5647e5fd26974514ac66cc3925f30601"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148043__a16dfaa16ceac4a33a468c0ae158292fb">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148043__a5635c1924d9648a8be89b1e5dcf0a87b">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0067148042.html">Region Management</a></div>
|
|
</div>
|
|
</div>
|
|
|