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 c94ea402f5 APIG API 20230331 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2023-07-13 08:57:09 +00:00

678 lines
28 KiB
HTML
Raw Blame History

<a name="ListInstancesV2"></a><a name="ListInstancesV2"></a>
<h1 class="topictitle1">Querying Dedicated Gateways</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query dedicated gateways.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/apigw/instances</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID. For details about how to obtain a project ID, see "Appendix" &gt; "Obtaining a Project ID" in this document.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.</p>
<p>Default: <strong>0</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>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>Minimum: <strong>1</strong></p>
<p>Maximum: <strong>500</strong></p>
<p>Default: <strong>20</strong></p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Gateway ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Gateway name.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Gateway status.</p>
<ul><li><p>Creating</p>
</li><li><p>CreateSuccess</p>
</li><li><p>CreateFail</p>
</li><li><p>Initing</p>
</li><li><p>Registering</p>
</li><li><p>Running</p>
</li><li><p>InitingFailed</p>
</li><li><p>RegisterFailed</p>
</li><li><p>Installing</p>
</li><li><p>InstallFailed</p>
</li><li><p>Updating</p>
</li><li><p>UpdateFailed</p>
</li><li><p>Rollbacking</p>
</li><li><p>RollbackSuccess</p>
</li><li><p>RollbackFailed</p>
</li><li><p>Deleting</p>
</li><li><p>DeleteFailed</p>
</li><li><p>Unregistering</p>
</li><li><p>UnRegisterFailed</p>
</li><li><p>CreateTimeout</p>
</li><li><p>InitTimeout</p>
</li><li><p>RegisterTimeout</p>
</li><li><p>InstallTimeout</p>
</li><li><p>UpdateTimeout</p>
</li><li><p>RollbackTimeout</p>
</li><li><p>DeleteTimeout</p>
</li><li><p>UnregisterTimeout</p>
</li><li><p>Starting</p>
</li><li><p>Freezing</p>
</li><li><p>Frozen</p>
</li><li><p>Restarting</p>
</li><li><p>RestartFail</p>
</li><li><p>Unhealthy</p>
</li><li><p>RestartTimeout</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>Creating</strong></p>
</li><li><p><strong>CreateSuccess</strong></p>
</li><li><p><strong>CreateFail</strong></p>
</li><li><p><strong>Initing</strong></p>
</li><li><p><strong>Registering</strong></p>
</li><li><p><strong>Running</strong></p>
</li><li><p><strong>InitingFailed</strong></p>
</li><li><p><strong>RegisterFailed</strong></p>
</li><li><p><strong>Installing</strong></p>
</li><li><p><strong>InstallFailed</strong></p>
</li><li><p><strong>Updating</strong></p>
</li><li><p><strong>UpdateFailed</strong></p>
</li><li><p><strong>Rollbacking</strong></p>
</li><li><p><strong>RollbackSuccess</strong></p>
</li><li><p><strong>RollbackFailed</strong></p>
</li><li><p><strong>Deleting</strong></p>
</li><li><p><strong>DeleteFailed</strong></p>
</li><li><p><strong>Unregistering</strong></p>
</li><li><p><strong>UnRegisterFailed</strong></p>
</li><li><p><strong>CreateTimeout</strong></p>
</li><li><p><strong>InitTimeout</strong></p>
</li><li><p><strong>RegisterTimeout</strong></p>
</li><li><p><strong>InstallTimeout</strong></p>
</li><li><p><strong>UpdateTimeout</strong></p>
</li><li><p><strong>RollbackTimeout</strong></p>
</li><li><p><strong>DeleteTimeout</strong></p>
</li><li><p><strong>UnregisterTimeout</strong></p>
</li><li><p><strong>Starting</strong></p>
</li><li><p><strong>Freezing</strong></p>
</li><li><p><strong>Frozen</strong></p>
</li><li><p><strong>Restarting</strong></p>
</li><li><p><strong>RestartFail</strong></p>
</li><li><p><strong>Unhealthy</strong></p>
</li><li><p><strong>RestartTimeout</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>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"><h4 class="sectiontitle">Response Parameters</h4><p><strong>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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Length of the returned resource list.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Number of resources that match the query conditions.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>instances</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListInstancesV2__response_RespInstanceBase">RespInstanceBase</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>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><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Gateway ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>ID of the tenant to which the gateway belongs.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Gateway name.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Gateway status.</p>
<ul><li><p>Creating</p>
</li><li><p>CreateSuccess</p>
</li><li><p>CreateFail</p>
</li><li><p>Initing</p>
</li><li><p>Registering</p>
</li><li><p>Running</p>
</li><li><p>InitingFailed</p>
</li><li><p>RegisterFailed</p>
</li><li><p>Installing</p>
</li><li><p>InstallFailed</p>
</li><li><p>Updating</p>
</li><li><p>UpdateFailed</p>
</li><li><p>Rollbacking</p>
</li><li><p>RollbackSuccess</p>
</li><li><p>RollbackFailed</p>
</li><li><p>Deleting</p>
</li><li><p>DeleteFailed</p>
</li><li><p>Unregistering</p>
</li><li><p>UnRegisterFailed</p>
</li><li><p>CreateTimeout</p>
</li><li><p>InitTimeout</p>
</li><li><p>RegisterTimeout</p>
</li><li><p>InstallTimeout</p>
</li><li><p>UpdateTimeout</p>
</li><li><p>RollbackTimeout</p>
</li><li><p>DeleteTimeout</p>
</li><li><p>UnregisterTimeout</p>
</li><li><p>Starting</p>
</li><li><p>Freezing</p>
</li><li><p>Frozen</p>
</li><li><p>Restarting</p>
</li><li><p>RestartFail</p>
</li><li><p>Unhealthy</p>
</li><li><p>RestartTimeout</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>Creating</strong></p>
</li><li><p><strong>CreateSuccess</strong></p>
</li><li><p><strong>CreateFail</strong></p>
</li><li><p><strong>Initing</strong></p>
</li><li><p><strong>Registering</strong></p>
</li><li><p><strong>Running</strong></p>
</li><li><p><strong>InitingFailed</strong></p>
</li><li><p><strong>RegisterFailed</strong></p>
</li><li><p><strong>Installing</strong></p>
</li><li><p><strong>InstallFailed</strong></p>
</li><li><p><strong>Updating</strong></p>
</li><li><p><strong>UpdateFailed</strong></p>
</li><li><p><strong>Rollbacking</strong></p>
</li><li><p><strong>RollbackSuccess</strong></p>
</li><li><p><strong>RollbackFailed</strong></p>
</li><li><p><strong>Deleting</strong></p>
</li><li><p><strong>DeleteFailed</strong></p>
</li><li><p><strong>Unregistering</strong></p>
</li><li><p><strong>UnRegisterFailed</strong></p>
</li><li><p><strong>CreateTimeout</strong></p>
</li><li><p><strong>InitTimeout</strong></p>
</li><li><p><strong>RegisterTimeout</strong></p>
</li><li><p><strong>InstallTimeout</strong></p>
</li><li><p><strong>UpdateTimeout</strong></p>
</li><li><p><strong>RollbackTimeout</strong></p>
</li><li><p><strong>DeleteTimeout</strong></p>
</li><li><p><strong>UnregisterTimeout</strong></p>
</li><li><p><strong>Starting</strong></p>
</li><li><p><strong>Freezing</strong></p>
</li><li><p><strong>Frozen</strong></p>
</li><li><p><strong>Restarting</strong></p>
</li><li><p><strong>RestartFail</strong></p>
</li><li><p><strong>Unhealthy</strong></p>
</li><li><p><strong>RestartTimeout</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>instance_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Gateway status ID.</p>
<ul><li><p>1: Creating</p>
</li><li><p>2: Created</p>
</li><li><p>3: Creation failed</p>
</li><li><p>4: Initializing</p>
</li><li><p>5: Registering</p>
</li><li><p>6: Running</p>
</li><li><p>7: Initialization failed</p>
</li><li><p>8: Registration failed</p>
</li><li><p>10: Installing</p>
</li><li><p>11: Installation failed</p>
</li><li><p>12: Upgrading</p>
</li><li><p>13: Upgrade failed</p>
</li><li><p>20: Rolling back</p>
</li><li><p>21: Rolled back</p>
</li><li><p>22: Rollback failed</p>
</li><li><p>23: Deleting</p>
</li><li><p>24: Deletion failed</p>
</li><li><p>25: Deregistering</p>
</li><li><p>26: Deregistration failed</p>
</li><li><p>27: Creation timeout</p>
</li><li><p>28: Initialization timeout</p>
</li><li><p>29: Registration timeout</p>
</li><li><p>30: Installation timeout</p>
</li><li><p>31: Upgrade timeout</p>
</li><li><p>32: Rollback timeout</p>
</li><li><p>33: Deletion timeout</p>
</li><li><p>34: Deregistration timeout</p>
</li><li><p>35: Starting</p>
</li><li><p>36: Freezing</p>
</li><li><p>37: Frozen</p>
</li><li><p>38: Restarting</p>
</li><li><p>39: Restarting failed</p>
</li><li><p>40: Abnormal</p>
</li><li><p>41: Restarting timeout</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>1</strong></p>
</li><li><p><strong>2</strong></p>
</li><li><p><strong>3</strong></p>
</li><li><p><strong>4</strong></p>
</li><li><p><strong>5</strong></p>
</li><li><p><strong>6</strong></p>
</li><li><p><strong>7</strong></p>
</li><li><p><strong>8</strong></p>
</li><li><p><strong>10</strong></p>
</li><li><p><strong>11</strong></p>
</li><li><p><strong>12</strong></p>
</li><li><p><strong>13</strong></p>
</li><li><p><strong>20</strong></p>
</li><li><p><strong>21</strong></p>
</li><li><p><strong>22</strong></p>
</li><li><p><strong>23</strong></p>
</li><li><p><strong>24</strong></p>
</li><li><p><strong>25</strong></p>
</li><li><p><strong>26</strong></p>
</li><li><p><strong>27</strong></p>
</li><li><p><strong>28</strong></p>
</li><li><p><strong>29</strong></p>
</li><li><p><strong>30</strong></p>
</li><li><p><strong>31</strong></p>
</li><li><p><strong>32</strong></p>
</li><li><p><strong>33</strong></p>
</li><li><p><strong>34</strong></p>
</li><li><p><strong>35</strong></p>
</li><li><p><strong>36</strong></p>
</li><li><p><strong>37</strong></p>
</li><li><p><strong>38</strong></p>
</li><li><p><strong>39</strong></p>
</li><li><p><strong>40</strong></p>
</li><li><p><strong>41</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Gateway type.</p>
<p>The default value is apig.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Gateway edition.</p>
<ul><li><p>BASIC</p>
</li><li><p>PROFESSIONAL</p>
</li><li><p>ENTERPRISE</p>
</li><li><p>PLATINUM</p>
</li><li><p>BASIC_IPV6</p>
</li><li><p>PROFESSIONAL_IPV6</p>
</li><li><p>ENTERPRISE_IPV6</p>
</li><li><p>PLATINUM_IPV6</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>BASIC</strong></p>
</li><li><p><strong>PROFESSIONAL</strong></p>
</li><li><p><strong>ENTERPRISE</strong></p>
</li><li><p><strong>PLATINUM</strong></p>
</li><li><p><strong>BASIC_IPV6</strong></p>
</li><li><p><strong>PROFESSIONAL_IPV6</strong></p>
</li><li><p><strong>ENTERPRISE_IPV6</strong></p>
</li><li><p><strong>PLATINUM_IPV6</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Time when the gateway is created. The time is in the Unix timestamp format.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Enterprise project ID. This parameter is required if you are using an enterprise account.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>eip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>EIP bound to the gateway.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>charging_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Billing mode of the gateway.</p>
<ul><li><p>0: pay-per-use</p>
</li><li><p>1: This parameter is not used currently.</p>
</li></ul>
<p>Enumeration values:</p>
<ul><li><p><strong>0</strong></p>
</li><li><p><strong>1</strong></p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>cbc_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>This parameter is not used currently.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>loadbalancer_provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Type of the load balancer used by the gateway.</p>
<ul><li><p>LVS</p>
</li><li><p>ELB (available only in certain regions)</p>
</li></ul>
<p>Default: <strong>lvs</strong></p>
<p>Enumeration values:</p>
<ul><li><p><strong>lvs</strong></p>
</li><li><p><strong>elb</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p><strong>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 6 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Error code.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p>error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p>Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p><strong>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 7 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p>error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p>Error code.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p>error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p>Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p><strong>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 8 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p>error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p>Error code.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p>error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p>Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>OK</p>
<pre class="screen">{
"total" : 2,
"size" : 2,
"instances" : [ {
"cbc_metadata" : "CS2006301043A28NF:00301-734023-0--0",
"charging_mode" : 1,
"create_time" : 1585302825070,
"eip_address" : "100.95.155.221",
"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" : "100.95.147.95",
"enterprise_project_id" : "0",
"id" : "2e2d613c64094a4a94ad38e7ca30adee",
"instance_name" : "apig-autotest-apitest-nodelete",
"instance_status" : 6,
"project_id" : "73d69ae0cfcf460190522d06b60f05ad",
"spec" : "PROFESSIONAL",
"status" : "Running",
"type" : "apig"
} ]
}</pre>
<p><strong>Status code: 401</strong></p>
<p>Unauthorized</p>
<pre class="screen">{
"error_code" : "APIC.7102",
"error_msg" : "Incorrect token or token resolution failed"
}</pre>
<p><strong>Status code: 403</strong></p>
<p>Forbidden</p>
<pre class="screen">{
"error_code" : "APIC.7106",
"error_msg" : "No permissions to request for the method"
}</pre>
<p><strong>Status code: 500</strong></p>
<p>Internal Server Error</p>
<pre class="screen">{
"error_code" : "APIC.9000",
"error_msg" : "Failed to request internal service"
}</pre>
</div>
<div class="section"><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><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>OK</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Unauthorized</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Forbidden</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Error Codes</h4><p>See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000023.html">Gateway Management</a></div>
</div>
</div>
View Git Blame Copy Permalink