vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/apig/api-ref/ListInstancesV2.html
Chen, Junjie 2fc8a34abd APIG API 20240125 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-10-25 11:19:06 +00:00

492 lines
53 KiB
HTML
Raw Blame History

<a name="ListInstancesV2"></a><a name="ListInstancesV2"></a>
<h1 class="topictitle1">Querying Dedicated Gateways</h1>
<div id="body2663152913279"><div class="section" id="ListInstancesV2__section6663172910273"><h4 class="sectiontitle">Function</h4><p id="ListInstancesV2__p8664162972712">This API is used to query dedicated gateways.</p>
</div>
<div class="section" id="ListInstancesV2__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="ListInstancesV2__p5664152922712">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
</div>
<div class="section" id="ListInstancesV2__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="ListInstancesV2__p6665112914276">GET /v2/{project_id}/apigw/instances</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__table5666112918279" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListInstancesV2__row16665192912714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListInstancesV2__p66677298278">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ListInstancesV2__p766782922713">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ListInstancesV2__p11668132911270">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ListInstancesV2__p96685293278">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row186651029112719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListInstancesV2__p7668102917270">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListInstancesV2__p18668202942718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListInstancesV2__p066952915272">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListInstancesV2__p26691529132716">Project ID. For details about how to obtain it, see <a href="apig-api-180713009.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__table20671192972710" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListInstancesV2__row17670202952710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ListInstancesV2__p9672162914274">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ListInstancesV2__p76721529152716">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ListInstancesV2__p66721829142715">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ListInstancesV2__p116721829162712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row156701329102714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListInstancesV2__p106731029102718">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListInstancesV2__p3673182915272">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListInstancesV2__p867318293276">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListInstancesV2__p176730290271">Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.</p>
<p id="ListInstancesV2__p56741929152713">Default: <strong id="ListInstancesV2__b1367417292271">0</strong></p>
</td>
</tr>
<tr id="ListInstancesV2__row1067022919272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListInstancesV2__p9674172992711">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListInstancesV2__p86745290273">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListInstancesV2__p146741729112715">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListInstancesV2__p8675132902719">Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.</p>
<p id="ListInstancesV2__p767562942715">Minimum: <strong id="ListInstancesV2__b1675929112720">1</strong></p>
<p id="ListInstancesV2__p667542962720">Maximum: <strong id="ListInstancesV2__b14675129182710">500</strong></p>
<p id="ListInstancesV2__p166751729112714">Default: <strong id="ListInstancesV2__b967592917271">20</strong></p>
</td>
</tr>
<tr id="ListInstancesV2__row467032911278"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListInstancesV2__p13675429112713">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListInstancesV2__p76768295273">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListInstancesV2__p146761129132717">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListInstancesV2__p16768291273">Gateway ID.</p>
</td>
</tr>
<tr id="ListInstancesV2__row1567172911278"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListInstancesV2__p146761429102711">instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListInstancesV2__p267714292273">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListInstancesV2__p36774292276">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListInstancesV2__p1067710299274">Gateway name.</p>
</td>
</tr>
<tr id="ListInstancesV2__row1067116294272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListInstancesV2__p1667719297273">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListInstancesV2__p15678182912710">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListInstancesV2__p0678172918278">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListInstancesV2__p10678162912718">Gateway status.</p>
<ul id="ListInstancesV2__ul10679629192713"><li id="ListInstancesV2__li18679112914270">Creating</li><li id="ListInstancesV2__li3679229102712">CreateSuccess</li><li id="ListInstancesV2__li36791729152719">CreateFail</li><li id="ListInstancesV2__li867912917273">Initing</li><li id="ListInstancesV2__li16679162962711">Registering</li><li id="ListInstancesV2__li14680132910270">Running</li><li id="ListInstancesV2__li1868012919273">InitingFailed</li><li id="ListInstancesV2__li1668012299278">RegisterFailed</li><li id="ListInstancesV2__li13680112902715">Installing</li><li id="ListInstancesV2__li116811129132714">InstallFailed</li><li id="ListInstancesV2__li96811629112710">Updating</li><li id="ListInstancesV2__li126811229172712">UpdateFailed</li><li id="ListInstancesV2__li268212922717">Rollbacking</li><li id="ListInstancesV2__li168282972711">RollbackSuccess</li><li id="ListInstancesV2__li1268282972717">RollbackFailed</li><li id="ListInstancesV2__li8682429202713">Deleting</li><li id="ListInstancesV2__li268392952719">DeleteFailed</li><li id="ListInstancesV2__li12683429172719">Unregistering</li><li id="ListInstancesV2__li8683329192718">UnRegisterFailed</li><li id="ListInstancesV2__li66831929172717">CreateTimeout</li><li id="ListInstancesV2__li17683029142714">InitTimeout</li><li id="ListInstancesV2__li1468462982719">RegisterTimeout</li><li id="ListInstancesV2__li36841929112711">InstallTimeout</li><li id="ListInstancesV2__li8684132919279">UpdateTimeout</li><li id="ListInstancesV2__li1868442962718">RollbackTimeout</li><li id="ListInstancesV2__li16841297276">DeleteTimeout</li><li id="ListInstancesV2__li168616296276">UnregisterTimeout</li><li id="ListInstancesV2__li11686162919278">Starting</li><li id="ListInstancesV2__li5686102917276">Freezing</li><li id="ListInstancesV2__li12686172962720">Frozen</li><li id="ListInstancesV2__li26875291277">Restarting</li><li id="ListInstancesV2__li1687182916277">RestartFail</li><li id="ListInstancesV2__li196876291272">Unhealthy</li><li id="ListInstancesV2__li168762962711">RestartTimeout</li></ul>
<p id="ListInstancesV2__p1968816297271">Enumeration values:</p>
<ul id="ListInstancesV2__ul96884299279"><li id="ListInstancesV2__li668811299273"><strong id="ListInstancesV2__b268872913275">Creating</strong></li><li id="ListInstancesV2__li368862912719"><strong id="ListInstancesV2__b1688202915276">CreateSuccess</strong></li><li id="ListInstancesV2__li4688122982714"><strong id="ListInstancesV2__b86893293270">CreateFail</strong></li><li id="ListInstancesV2__li1368912299275"><strong id="ListInstancesV2__b186891529122715">Initing</strong></li><li id="ListInstancesV2__li186899295276"><strong id="ListInstancesV2__b3689929132714">Registering</strong></li><li id="ListInstancesV2__li14689172920276"><strong id="ListInstancesV2__b19689202910271">Running</strong></li><li id="ListInstancesV2__li1469017293270"><strong id="ListInstancesV2__b769062919278">InitingFailed</strong></li><li id="ListInstancesV2__li1369020298279"><strong id="ListInstancesV2__b19690129112717">RegisterFailed</strong></li><li id="ListInstancesV2__li186901029192718"><strong id="ListInstancesV2__b20690192918275">Installing</strong></li><li id="ListInstancesV2__li16690192920276"><strong id="ListInstancesV2__b15690192942715">InstallFailed</strong></li><li id="ListInstancesV2__li2690102962711"><strong id="ListInstancesV2__b369118299277">Updating</strong></li><li id="ListInstancesV2__li15691182982714"><strong id="ListInstancesV2__b196911829172714">UpdateFailed</strong></li><li id="ListInstancesV2__li116911929192718"><strong id="ListInstancesV2__b769112291277">Rollbacking</strong></li><li id="ListInstancesV2__li1691162915277"><strong id="ListInstancesV2__b1669113292274">RollbackSuccess</strong></li><li id="ListInstancesV2__li20691329192715"><strong id="ListInstancesV2__b4692129202713">RollbackFailed</strong></li><li id="ListInstancesV2__li069262914278"><strong id="ListInstancesV2__b1969232911274">Deleting</strong></li><li id="ListInstancesV2__li166922292276"><strong id="ListInstancesV2__b96921298275">DeleteFailed</strong></li><li id="ListInstancesV2__li12692929142716"><strong id="ListInstancesV2__b18692122917279">Unregistering</strong></li><li id="ListInstancesV2__li166924295279"><strong id="ListInstancesV2__b869310296274">UnRegisterFailed</strong></li><li id="ListInstancesV2__li1469332918271"><strong id="ListInstancesV2__b126931229122713">CreateTimeout</strong></li><li id="ListInstancesV2__li669352918273"><strong id="ListInstancesV2__b66931629172717">InitTimeout</strong></li><li id="ListInstancesV2__li17693529192713"><strong id="ListInstancesV2__b146933295273">RegisterTimeout</strong></li><li id="ListInstancesV2__li1969332932716"><strong id="ListInstancesV2__b116931297275">InstallTimeout</strong></li><li id="ListInstancesV2__li969422992718"><strong id="ListInstancesV2__b169462911279">UpdateTimeout</strong></li><li id="ListInstancesV2__li4694132916277"><strong id="ListInstancesV2__b18694172912274">RollbackTimeout</strong></li><li id="ListInstancesV2__li56941629182715"><strong id="ListInstancesV2__b1869442952718">DeleteTimeout</strong></li><li id="ListInstancesV2__li369419299277"><strong id="ListInstancesV2__b969416296278">UnregisterTimeout</strong></li><li id="ListInstancesV2__li10694029172714"><strong id="ListInstancesV2__b1169512297272">Starting</strong></li><li id="ListInstancesV2__li469562952717"><strong id="ListInstancesV2__b2069592911273">Freezing</strong></li><li id="ListInstancesV2__li569582972713"><strong id="ListInstancesV2__b156958290274">Frozen</strong></li><li id="ListInstancesV2__li469518294275"><strong id="ListInstancesV2__b16695192913270">Restarting</strong></li><li id="ListInstancesV2__li116957290270"><strong id="ListInstancesV2__b66951929102712">RestartFail</strong></li><li id="ListInstancesV2__li1696122982720"><strong id="ListInstancesV2__b4696182918276">Unhealthy</strong></li><li id="ListInstancesV2__li3696192952718"><strong id="ListInstancesV2__b1469662932718">RestartTimeout</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstancesV2__section6696182913274"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListInstancesV2__row14697192962716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListInstancesV2__p116981929132719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListInstancesV2__p069819291275">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListInstancesV2__p10698129142713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListInstancesV2__p106981829132717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row1697129172715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListInstancesV2__p1169920297278">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListInstancesV2__p15699132911272">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListInstancesV2__p16699729132717">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListInstancesV2__p76991529152715">User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstancesV2__section14700142911276"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstancesV2__p14700142917275"><strong id="ListInstancesV2__b970122912278">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__response_RespInstancePage" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListInstancesV2__row27011729102716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ListInstancesV2__p13702102912712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ListInstancesV2__p4702329122719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ListInstancesV2__p570352972715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row17701112913272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListInstancesV2__p8703152911275">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListInstancesV2__p157031829102713">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListInstancesV2__p1170482942716">Length of the returned resource list.</p>
</td>
</tr>
<tr id="ListInstancesV2__row11701202972714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListInstancesV2__p770472912272">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListInstancesV2__p17041329152711">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListInstancesV2__p2070515295275">Number of resources that match the query conditions.</p>
</td>
</tr>
<tr id="ListInstancesV2__row2701122922718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListInstancesV2__p177051729182716">instances</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListInstancesV2__p15705172972718">Array of <a href="#ListInstancesV2__response_RespInstanceBase">RespInstanceBase</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListInstancesV2__p1770662902715">Gateway list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstancesV2__response_RespInstanceBase"></a><a name="response_RespInstanceBase"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__response_RespInstanceBase" frame="border" border="1" rules="all"><caption><b>Table 5 </b>RespInstanceBase</caption><thead align="left"><tr id="ListInstancesV2__row6707142982720"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="ListInstancesV2__p570932911279">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="ListInstancesV2__p3710112992710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="ListInstancesV2__p177101829192716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row6707162910271"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p107111529122719">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p1971118294271">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p171182916279">Gateway ID.</p>
</td>
</tr>
<tr id="ListInstancesV2__row870742932716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p20712122912712">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p5712192972715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p12712172912712">ID of the tenant to which the gateway belongs.</p>
</td>
</tr>
<tr id="ListInstancesV2__row1707202982716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p17713102982718">instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p9713172952718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p14713102982715">Gateway name.</p>
</td>
</tr>
<tr id="ListInstancesV2__row10707122942711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p16714182932712">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p47147291279">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p171582918279">Instance status:</p>
<ul id="ListInstancesV2__ul67151729182715"><li id="ListInstancesV2__li971517298276">Creating: The instance is being created.</li><li id="ListInstancesV2__li107151129182711">CreateSuccess: The instance is created successfully.</li><li id="ListInstancesV2__li16716172914272">CreateFail: The instance fails to be created.</li><li id="ListInstancesV2__li16716929142717">Initing: The instance is being initialized.</li><li id="ListInstancesV2__li97163298276">Registering: The instance is being registered.</li><li id="ListInstancesV2__li1471672916271">Running: The instance is running.</li><li id="ListInstancesV2__li16716182910279">InitingFailed: The instance fails to be initialized.</li><li id="ListInstancesV2__li17717132913272">RegisterFailed: The instance fails to be registered.</li><li id="ListInstancesV2__li157172292279">Installing: The instance is being installed.</li><li id="ListInstancesV2__li871715299277">InstallFailed: The instance fails to be installed.</li><li id="ListInstancesV2__li13717132922717">Updating: The instance is being upgraded.</li><li id="ListInstancesV2__li1571762915270">UpdateFailed: The instance fails to be upgraded.</li><li id="ListInstancesV2__li15718129142715">Rollbacking: The instance is being rolled back.</li><li id="ListInstancesV2__li7718129182710">RollbackSuccess: The instance is rolled back successfully.</li><li id="ListInstancesV2__li6718429172716">RollbackFailed: The instance fails to be rolled back.</li><li id="ListInstancesV2__li171802902718">Deleting: The instance is being deleted.</li><li id="ListInstancesV2__li6719122962716">DeleteFailed: The instance fails to be deleted.</li><li id="ListInstancesV2__li1071952982712">Unregistering: The instance is being deregistered.</li><li id="ListInstancesV2__li7719112922713">UnRegisterFailed: The instance fails to be deregistered.</li><li id="ListInstancesV2__li9719629172719">CreateTimeout: Creation of the instance times out.</li><li id="ListInstancesV2__li1172019297276">InitTimeout: Initialization of the instance times out.</li><li id="ListInstancesV2__li177201829152716">RegisterTimeout: Registration of the instance times out.</li><li id="ListInstancesV2__li14720029142719">InstallTimeout: Installation of the instance times out.</li><li id="ListInstancesV2__li172412295278">UpdateTimeout: Upgrading of the instance times out.</li><li id="ListInstancesV2__li9724132914275">RollbackTimeout: Rollback of the instance times out.</li><li id="ListInstancesV2__li9725102918276">DeleteTimeout: Deletion of the instance times out.</li><li id="ListInstancesV2__li9725192914279">UnregisterTimeout: Deregistration of the instance times out.</li><li id="ListInstancesV2__li20725172982716">Starting: The instance is being started.</li><li id="ListInstancesV2__li19725172952717">Freezing: The instance is being frozen.</li><li id="ListInstancesV2__li4725192920271">Frozen: The instance is frozen.</li><li id="ListInstancesV2__li1572613294277">Restarting: The instance is being restarted.</li><li id="ListInstancesV2__li57262290279">RestartFail: The instance fails to be restarted.</li><li id="ListInstancesV2__li772611294278">Unhealthy: The instance is abnormal.</li><li id="ListInstancesV2__li972682912718">RestartTimeout: Restart of the instance times out.</li><li id="ListInstancesV2__li1472713295278">Resizing: The instance specification is changing.</li><li id="ListInstancesV2__li12727102962719">ResizeFailed: The instance specification fails to be changed.</li><li id="ListInstancesV2__li972782992719">ResizeTimeout: The instance specification change times out.</li></ul>
<p id="ListInstancesV2__p97276293278">Enumeration values:</p>
<ul id="ListInstancesV2__ul5728162911275"><li id="ListInstancesV2__li8728192972719"><strong id="ListInstancesV2__b147281829152713">Creating</strong></li><li id="ListInstancesV2__li1372818291274"><strong id="ListInstancesV2__b1973192914278">CreateSuccess</strong></li><li id="ListInstancesV2__li023017302274"><strong id="ListInstancesV2__b8231183018270">CreateFail</strong></li><li id="ListInstancesV2__li102311730102716"><strong id="ListInstancesV2__b2231930162712">Initing</strong></li><li id="ListInstancesV2__li92311330172713"><strong id="ListInstancesV2__b182312030162719">Registering</strong></li><li id="ListInstancesV2__li102315308275"><strong id="ListInstancesV2__b1123153018277">Running</strong></li><li id="ListInstancesV2__li423110304278"><strong id="ListInstancesV2__b723113082710">InitingFailed</strong></li><li id="ListInstancesV2__li202313309273"><strong id="ListInstancesV2__b19232183015273">RegisterFailed</strong></li><li id="ListInstancesV2__li192323305278"><strong id="ListInstancesV2__b32361630102720">Installing</strong></li><li id="ListInstancesV2__li1023614305277"><strong id="ListInstancesV2__b132366308274">InstallFailed</strong></li><li id="ListInstancesV2__li423743002714"><strong id="ListInstancesV2__b1237133014273">Updating</strong></li><li id="ListInstancesV2__li1523763022716"><strong id="ListInstancesV2__b162371430112718">UpdateFailed</strong></li><li id="ListInstancesV2__li13237123017271"><strong id="ListInstancesV2__b023717308279">Rollbacking</strong></li><li id="ListInstancesV2__li8237930162719"><strong id="ListInstancesV2__b923716305278">RollbackSuccess</strong></li><li id="ListInstancesV2__li14237113011279"><strong id="ListInstancesV2__b1237530102711">RollbackFailed</strong></li><li id="ListInstancesV2__li1623733018271"><strong id="ListInstancesV2__b423710302278">Deleting</strong></li><li id="ListInstancesV2__li1623715305279"><strong id="ListInstancesV2__b9238530182710">DeleteFailed</strong></li><li id="ListInstancesV2__li192381030112715"><strong id="ListInstancesV2__b723812307270">Unregistering</strong></li><li id="ListInstancesV2__li5238103092715"><strong id="ListInstancesV2__b923883082719">UnRegisterFailed</strong></li><li id="ListInstancesV2__li1238123012279"><strong id="ListInstancesV2__b3238193016275">CreateTimeout</strong></li><li id="ListInstancesV2__li123813015278"><strong id="ListInstancesV2__b1423883092715">InitTimeout</strong></li><li id="ListInstancesV2__li023803012276"><strong id="ListInstancesV2__b18238153012711">RegisterTimeout</strong></li><li id="ListInstancesV2__li12238103014273"><strong id="ListInstancesV2__b1923963014274">InstallTimeout</strong></li><li id="ListInstancesV2__li7239730132718"><strong id="ListInstancesV2__b19239630182711">UpdateTimeout</strong></li><li id="ListInstancesV2__li42397309274"><strong id="ListInstancesV2__b14239530202714">RollbackTimeout</strong></li><li id="ListInstancesV2__li523963014274"><strong id="ListInstancesV2__b823973019276">DeleteTimeout</strong></li><li id="ListInstancesV2__li2023910306276"><strong id="ListInstancesV2__b1023943052710">UnregisterTimeout</strong></li><li id="ListInstancesV2__li3239143032710"><strong id="ListInstancesV2__b6239630152711">Starting</strong></li><li id="ListInstancesV2__li142441830112710"><strong id="ListInstancesV2__b2244173002718">Freezing</strong></li><li id="ListInstancesV2__li1224413082710"><strong id="ListInstancesV2__b6244030172714">Frozen</strong></li><li id="ListInstancesV2__li19244193020276"><strong id="ListInstancesV2__b52443305275">Restarting</strong></li><li id="ListInstancesV2__li52441730192713"><strong id="ListInstancesV2__b3244430112719">RestartFail</strong></li><li id="ListInstancesV2__li10244730192715"><strong id="ListInstancesV2__b2244130152713">Unhealthy</strong></li><li id="ListInstancesV2__li1924415309273"><strong id="ListInstancesV2__b1324413002714">RestartTimeout</strong></li><li id="ListInstancesV2__li19244203072713"><strong id="ListInstancesV2__b2024420309277">Resizing</strong></li><li id="ListInstancesV2__li1524413016275"><strong id="ListInstancesV2__b15245730172712">ResizeFailed</strong></li><li id="ListInstancesV2__li13245193013276"><strong id="ListInstancesV2__b52451530192716">ResizeTimeout</strong></li></ul>
</td>
</tr>
<tr id="ListInstancesV2__row13707202911278"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p62453307274">instance_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p524519307277">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p102451430192720">Instance status ID:</p>
<ul id="ListInstancesV2__ul424510305278"><li id="ListInstancesV2__li14245630142717">1: Creating</li><li id="ListInstancesV2__li1024512307277">2: Created successfully</li><li id="ListInstancesV2__li824616301276">3: Creation failed</li><li id="ListInstancesV2__li1024693012710">4: Initializing</li><li id="ListInstancesV2__li12461830122716">5: Registering</li><li id="ListInstancesV2__li9246130172718">6: Running</li><li id="ListInstancesV2__li18246153012272">7: Initialization failed</li><li id="ListInstancesV2__li2246103015274">8: Registration failed</li><li id="ListInstancesV2__li724613010275">10: Installing</li><li id="ListInstancesV2__li11247330192714">11: Installation failed</li><li id="ListInstancesV2__li5247163072712">12: Upgrading</li><li id="ListInstancesV2__li20247143072711">13: Upgrade failed</li><li id="ListInstancesV2__li724723017270">20: Rolling back</li><li id="ListInstancesV2__li20250530172718">21: Rolled back</li><li id="ListInstancesV2__li14250630102711">22: Rollback failed</li><li id="ListInstancesV2__li1325053015276">23: Deleting</li><li id="ListInstancesV2__li1225023092710">24: Deletion failed</li><li id="ListInstancesV2__li1625083072718">25: Deregistering</li><li id="ListInstancesV2__li19250193082714">26: Deregistration failed</li><li id="ListInstancesV2__li1250123052716">27: Creation timed out</li><li id="ListInstancesV2__li6251830182718">28: Initialization timed out</li><li id="ListInstancesV2__li32511930192710">29: Registration timed out</li><li id="ListInstancesV2__li18251130102713">30: Installation timed out</li><li id="ListInstancesV2__li14251103072715">31: Upgrade timed out</li><li id="ListInstancesV2__li12251173020273">32: Rollback timed out</li><li id="ListInstancesV2__li4251130132720">33: Deletion timed out</li><li id="ListInstancesV2__li11251183019276">34: Deregistration timed out</li><li id="ListInstancesV2__li12251230152716">35: Starting</li><li id="ListInstancesV2__li425113020275">36: Freezing</li><li id="ListInstancesV2__li17251123062711">37: Frozen</li><li id="ListInstancesV2__li1925183062712">38: Restarting</li><li id="ListInstancesV2__li16252193062715">39: Restart failed</li><li id="ListInstancesV2__li925293015273">40: Abnormal</li><li id="ListInstancesV2__li1825243010278">41: Restart timed out</li><li id="ListInstancesV2__li7252203019275">42: Changing specification</li><li id="ListInstancesV2__li1425223092712">43: Specification change failed</li><li id="ListInstancesV2__li14252113012713">44: Specification change timed out</li></ul>
<p id="ListInstancesV2__p9252133022719">Enumeration values:</p>
<ul id="ListInstancesV2__ul1025243052710"><li id="ListInstancesV2__li1425283082719"><strong id="ListInstancesV2__b52531630162719">1</strong></li><li id="ListInstancesV2__li142533304278"><strong id="ListInstancesV2__b18253130122714">2</strong></li><li id="ListInstancesV2__li3254830202710"><strong id="ListInstancesV2__b92541830122717">3</strong></li><li id="ListInstancesV2__li8254163018274"><strong id="ListInstancesV2__b11254143019276">4</strong></li><li id="ListInstancesV2__li14254203017276"><strong id="ListInstancesV2__b2254330182718">5</strong></li><li id="ListInstancesV2__li025513012277"><strong id="ListInstancesV2__b325563014271">6</strong></li><li id="ListInstancesV2__li92551030192715"><strong id="ListInstancesV2__b5255193042714">7</strong></li><li id="ListInstancesV2__li11255193015274"><strong id="ListInstancesV2__b19255153042719">8</strong></li><li id="ListInstancesV2__li11255230162717"><strong id="ListInstancesV2__b9255430182720">10</strong></li><li id="ListInstancesV2__li02553301274"><strong id="ListInstancesV2__b1425511304276">11</strong></li><li id="ListInstancesV2__li12551530122713"><strong id="ListInstancesV2__b1255930112710">12</strong></li><li id="ListInstancesV2__li72551630152716"><strong id="ListInstancesV2__b182551230172719">13</strong></li><li id="ListInstancesV2__li12555306275"><strong id="ListInstancesV2__b13255123019276">20</strong></li><li id="ListInstancesV2__li1225615300273"><strong id="ListInstancesV2__b102561730192717">21</strong></li><li id="ListInstancesV2__li10256530112718"><strong id="ListInstancesV2__b122569305278">22</strong></li><li id="ListInstancesV2__li20256630102718"><strong id="ListInstancesV2__b1825613052711">23</strong></li><li id="ListInstancesV2__li62564302275"><strong id="ListInstancesV2__b7256193015271">24</strong></li><li id="ListInstancesV2__li202561630102719"><strong id="ListInstancesV2__b172561130162715">25</strong></li><li id="ListInstancesV2__li5256153010279"><strong id="ListInstancesV2__b72561304273">26</strong></li><li id="ListInstancesV2__li17256930102711"><strong id="ListInstancesV2__b17256193017276">27</strong></li><li id="ListInstancesV2__li1725623072713"><strong id="ListInstancesV2__b825612305278">28</strong></li><li id="ListInstancesV2__li125713072715"><strong id="ListInstancesV2__b9258830112714">29</strong></li><li id="ListInstancesV2__li72581930132712"><strong id="ListInstancesV2__b125817306272">30</strong></li><li id="ListInstancesV2__li42581230192716"><strong id="ListInstancesV2__b1225873042717">31</strong></li><li id="ListInstancesV2__li1325833019279"><strong id="ListInstancesV2__b1225873062712">32</strong></li><li id="ListInstancesV2__li1259113082720"><strong id="ListInstancesV2__b102591730142710">33</strong></li><li id="ListInstancesV2__li825923019273"><strong id="ListInstancesV2__b82591930102713">34</strong></li><li id="ListInstancesV2__li1125923019274"><strong id="ListInstancesV2__b22591030102718">35</strong></li><li id="ListInstancesV2__li1525953012713"><strong id="ListInstancesV2__b142591430162714">36</strong></li><li id="ListInstancesV2__li162596303279"><strong id="ListInstancesV2__b1125912309271">37</strong></li><li id="ListInstancesV2__li3260730102715"><strong id="ListInstancesV2__b526053022718">38</strong></li><li id="ListInstancesV2__li12601130142719"><strong id="ListInstancesV2__b15260173018275">39</strong></li><li id="ListInstancesV2__li12604302276"><strong id="ListInstancesV2__b152600306273">40</strong></li><li id="ListInstancesV2__li7260133082718"><strong id="ListInstancesV2__b1926033015277">41</strong></li><li id="ListInstancesV2__li026014302278"><strong id="ListInstancesV2__b10260133015271">42</strong></li><li id="ListInstancesV2__li626003020275"><strong id="ListInstancesV2__b3260113072719">43</strong></li><li id="ListInstancesV2__li15260113011278"><strong id="ListInstancesV2__b62601308273">44</strong></li></ul>
</td>
</tr>
<tr id="ListInstancesV2__row270717298271"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p52601830132710">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p026123022710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p13261203082719">Gateway type.</p>
<p id="ListInstancesV2__p0261830112711">The default value is apig.</p>
</td>
</tr>
<tr id="ListInstancesV2__row670712920277"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p7261130152720">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p82611230162714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p5261430132719">Gateway edition.</p>
<ul id="ListInstancesV2__ul4261113012719"><li id="ListInstancesV2__li526123012278">BASIC</li><li id="ListInstancesV2__li026113307270">PROFESSIONAL</li><li id="ListInstancesV2__li426223019279">ENTERPRISE</li><li id="ListInstancesV2__li1626211301271">PLATINUM</li></ul>
<p id="ListInstancesV2__p02621730142710">Enumeration values:</p>
<ul id="ListInstancesV2__ul3262030142716"><li id="ListInstancesV2__li17262183010270"><strong id="ListInstancesV2__b02623307271">BASIC</strong></li><li id="ListInstancesV2__li20262143020277"><strong id="ListInstancesV2__b10262173014273">PROFESSIONAL</strong></li><li id="ListInstancesV2__li92627303277"><strong id="ListInstancesV2__b152633308272">ENTERPRISE</strong></li><li id="ListInstancesV2__li9263123032715"><strong id="ListInstancesV2__b7263163011276">PLATINUM</strong></li></ul>
</td>
</tr>
<tr id="ListInstancesV2__row14707132912713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p13265730142715">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p6265183072716">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p112665305277">Time when the gateway is created. The time is in the Unix timestamp format.</p>
</td>
</tr>
<tr id="ListInstancesV2__row3707629182711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p4266113011271">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p5266630102715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p14266103015270">Enterprise project ID. This parameter is required for an enterprise account.</p>
</td>
</tr>
<tr id="ListInstancesV2__row37081299274"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p182663305277">eip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p42660305278">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p1126615304270">EIP bound to the gateway.</p>
</td>
</tr>
<tr id="ListInstancesV2__row970802932718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p9266183012273">charging_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p2026643019272">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p112663309278">Billing mode of the gateway.</p>
<ul id="ListInstancesV2__ul15266113016274"><li id="ListInstancesV2__li426603016273">0: pay-per-use</li><li id="ListInstancesV2__li15266330202713">1: This parameter is not used currently.</li></ul>
<p id="ListInstancesV2__p6267130162718">Enumeration values:</p>
<ul id="ListInstancesV2__ul1226718307271"><li id="ListInstancesV2__li14267173020276"><strong id="ListInstancesV2__b1226703019276">0</strong></li><li id="ListInstancesV2__li122671301274"><strong id="ListInstancesV2__b202670304271">1</strong></li></ul>
</td>
</tr>
<tr id="ListInstancesV2__row17708172910272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p62671730102719">cbc_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p62675307277">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p152671930172715">This parameter is not used currently.</p>
</td>
</tr>
<tr id="ListInstancesV2__row1870882932720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p15267123022713">loadbalancer_provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p16267113013277">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p1326763019279">Type of the load balancer used by the gateway.</p>
<ul id="ListInstancesV2__ul026713010278"><li id="ListInstancesV2__li1226813307278">ELB</li></ul>
<p id="ListInstancesV2__p1326818308276">Enumeration values:</p>
<ul id="ListInstancesV2__ul192751303271"><li id="ListInstancesV2__li1827663015274"><strong id="ListInstancesV2__b142763307278">elb</strong></li></ul>
</td>
</tr>
<tr id="ListInstancesV2__row7708329182716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListInstancesV2__p22768305274">cbc_operation_locks</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListInstancesV2__p1276130172718">Array of <a href="#ListInstancesV2__response_CbcOperationLock">CbcOperationLock</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListInstancesV2__p127873052711">Cloud operations restriction lock.</p>
<p id="ListInstancesV2__p1753292072519">This parameter is not used currently.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstancesV2__response_CbcOperationLock"></a><a name="response_CbcOperationLock"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__response_CbcOperationLock" frame="border" border="1" rules="all"><caption><b>Table 6 </b>CbcOperationLock</caption><thead align="left"><tr id="ListInstancesV2__row19760122912277"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ListInstancesV2__p1827913042718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ListInstancesV2__p152791430122713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ListInstancesV2__p12280230132717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row1576020293270"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ListInstancesV2__p928017302278">lock_scene</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ListInstancesV2__p12280630202713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ListInstancesV2__p32801130172713">Restriction scenarios:</p>
<ul id="ListInstancesV2__ul0280330102712"><li id="ListInstancesV2__li16280133016275">TO_PERIOD_LOCK: Changing the billing mode from pay-per-use to yearly/monthly. In this scenario, deleting resources, changing specifications, and changing from pay-per-use to yearly/monthly are not allowed.</li><li id="ListInstancesV2__li15280173015271">SPEC_CHG_LOCK: Changing specifications of the yearly/monthly billing mode. In this scenario, deleting resources and changing specifications are not allowed.</li></ul>
<p id="ListInstancesV2__p2280173072712">Enumeration values:</p>
<ul id="ListInstancesV2__ul17280163072715"><li id="ListInstancesV2__li16281173014271"><strong id="ListInstancesV2__b15281143015278">TO_PERIOD_LOCK</strong></li><li id="ListInstancesV2__li16281163016277"><strong id="ListInstancesV2__b17281430122717">PEC_CHG_LOCK</strong></li></ul>
</td>
</tr>
<tr id="ListInstancesV2__row1676012902711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ListInstancesV2__p12811930192718">lock_source_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ListInstancesV2__p6281930132716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ListInstancesV2__p3281630142712">ID of the object that initiates the restriction</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstancesV2__p18281103014272"><strong id="ListInstancesV2__b1128103062712">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListInstancesV2__row97631229172711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="ListInstancesV2__p2282103013274">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="ListInstancesV2__p1428243015274">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="ListInstancesV2__p0282930112710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row1476311295275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ListInstancesV2__p1282173042713">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ListInstancesV2__p62823302275">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ListInstancesV2__p32825304279">Error code.</p>
</td>
</tr>
<tr id="ListInstancesV2__row87641629132720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ListInstancesV2__p128203022717">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ListInstancesV2__p82821430142720">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ListInstancesV2__p1328273042711">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstancesV2__p92821730142717"><strong id="ListInstancesV2__b19282133082715">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListInstancesV2__row17766102972713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="ListInstancesV2__p1428353012277">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="ListInstancesV2__p728314308273">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="ListInstancesV2__p928343082716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row97668292273"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ListInstancesV2__p02831730192717">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ListInstancesV2__p728363012279">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ListInstancesV2__p528314307278">Error code.</p>
</td>
</tr>
<tr id="ListInstancesV2__row1376619294276"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ListInstancesV2__p928333011272">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ListInstancesV2__p4283133012715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ListInstancesV2__p3283143011273">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstancesV2__p1283530192714"><strong id="ListInstancesV2__b528317302271">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListInstancesV2__row1576922919272"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="ListInstancesV2__p132847303271">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="ListInstancesV2__p1228423015273">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="ListInstancesV2__p1028413022716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row476912922719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ListInstancesV2__p32842305273">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ListInstancesV2__p1328412303271">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ListInstancesV2__p128453012272">Error code.</p>
</td>
</tr>
<tr id="ListInstancesV2__row16769172922719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ListInstancesV2__p628453011275">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ListInstancesV2__p15287230162716">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ListInstancesV2__p828823082719">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstancesV2__section8294230192719"><h4 class="sectiontitle">Example Requests</h4><p id="ListInstancesV2__p132946303278">None</p>
</div>
<div class="section" id="ListInstancesV2__section202941530142711"><h4 class="sectiontitle">Example Responses</h4><p id="ListInstancesV2__p112941530162713"><strong id="ListInstancesV2__b1929416304276">Status code: 200</strong></p>
<p id="ListInstancesV2__p1294430162714">OK</p>
<pre class="screen" id="ListInstancesV2__screen529510308278">{
"total" : 2,
"size" : 2,
"instances" : [ {
"cbc_metadata" : "CS2006301043A28NF:00301-734023-0--0",
"charging_mode" : 1,
"create_time" : 1585302825070,
"eip_address" : "xxx.xxx.xxx.xxx",
"enterprise_project_id" : "0",
"id" : "eddc4d25480b4cd6b512f270a1b8b341",
"instance_name" : "apig-Enterprise_Project_Pay-per-Use",
"instance_status" : 6,
"project_id" : "73d69ae0cfcf460190522d06b60f05ad",
"spec" : "PROFESSIONAL",
"status" : "Running",
"type" : "apig"
}, {
"charging_mode" : 0,
"create_time" : 1594370987422,
"eip_address" : "xxx.xxx.xxx.xxx",
"enterprise_project_id" : "0",
"id" : "2e2d613c64094a4a94ad38e7ca30adee",
"instance_name" : "apig-autotest-apitest-nodelete",
"instance_status" : 6,
"project_id" : "73d69ae0cfcf460190522d06b60f05ad",
"spec" : "PROFESSIONAL",
"status" : "Running",
"type" : "apig",
"cbc_operation_locks" : [ {
"lock_scene" : "TO_PERIOD_LOCK",
"lock_source_id" : "CxxxxxxxxxxxM"
} ]
} ]
}</pre>
<p id="ListInstancesV2__p62966305275"><strong id="ListInstancesV2__b18296530182717">Status code: 401</strong></p>
<p id="ListInstancesV2__p1929623052714">Unauthorized</p>
<pre class="screen" id="ListInstancesV2__screen1296130102718">{
"error_code" : "APIC.7102",
"error_msg" : "Incorrect token or token resolution failed"
}</pre>
<p id="ListInstancesV2__p192972302276"><strong id="ListInstancesV2__b13297123019277">Status code: 403</strong></p>
<p id="ListInstancesV2__p529773092712">Forbidden</p>
<pre class="screen" id="ListInstancesV2__screen3297153032710">{
"error_code" : "APIC.7106",
"error_msg" : "No permissions to request for the method"
}</pre>
<p id="ListInstancesV2__p22971430152711"><strong id="ListInstancesV2__b4297133019277">Status code: 500</strong></p>
<p id="ListInstancesV2__p129710308271">Internal Server Error</p>
<pre class="screen" id="ListInstancesV2__screen192971630192713">{
"error_code" : "APIC.9000",
"error_msg" : "Failed to request internal service"
}</pre>
</div>
<div class="section" id="ListInstancesV2__section6298153010273"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstancesV2__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListInstancesV2__row1782329112711"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ListInstancesV2__p132982030202716">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ListInstancesV2__p429812308274">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstancesV2__row207821829142717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListInstancesV2__p8298123013271">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListInstancesV2__p18298830102713">OK</p>
</td>
</tr>
<tr id="ListInstancesV2__row9782162911274"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListInstancesV2__p529883015275">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListInstancesV2__p122986303272">Unauthorized</p>
</td>
</tr>
<tr id="ListInstancesV2__row8782152982717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListInstancesV2__p15298123011271">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListInstancesV2__p14298830122710">Forbidden</p>
</td>
</tr>
<tr id="ListInstancesV2__row17821329102710"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListInstancesV2__p72982305271">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListInstancesV2__p1729853012718">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstancesV2__section14298153012278"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstancesV2__p82991330192719">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ApicInstanceManagement.html">Gateway Management</a></div>
</div>
</div>
View Git Blame Copy Permalink