yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
f8f1b77f86f7141b8084a92b696e1354b26fba09
doc-exports/docs/wafd/api-ref/ListInstance.html
qinweiwei 14cbe51752 wafd API 20260210 version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: qinweiwei <qinweiwei@huawei.com>
Co-committed-by: qinweiwei <qinweiwei@huawei.com>
2026-04-21 11:31:19 +00:00

539 lines
38 KiB
HTML
Raw Blame History

<a name="ListInstance"></a><a name="ListInstance"></a>
<h1 class="topictitle1">Querying the List of Dedicated WAF Engines</h1>
<div id="body1708331107508"><div class="section" id="ListInstance__topic1011000000"><h4 class="sectiontitle">Function</h4><p id="ListInstance__topic1011000002">This API is used to query the list of dedicated WAF engines.</p>
</div>
<div class="section" id="ListInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ListInstance__topic1011000004">GET /v1/{project_id}/premium-waf/instance</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__topic1011000005" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListInstance__topic1011000013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListInstance__topic1011000015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListInstance__topic1011000017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListInstance__topic1011000019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListInstance__topic1011000021">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000023"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListInstance__topic1011000025">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListInstance__topic1011000027">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListInstance__topic1011000029">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListInstance__topic1011000031">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__topic1011000032" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListInstance__topic1011000040"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListInstance__topic1011000042">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListInstance__topic1011000044">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListInstance__topic1011000046">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListInstance__topic1011000048">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000050"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstance__topic1011000052">page</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstance__topic1011000054">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstance__topic1011000056">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstance__topic1011000058">Page number, which is required for pagination query</p>
</td>
</tr>
<tr id="ListInstance__topic1011000059"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstance__topic1011000061">pagesize</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstance__topic1011000063">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstance__topic1011000065">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstance__topic1011000067">Number of records on each page, which is required for pagination query</p>
</td>
</tr>
<tr id="ListInstance__topic1011000068"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListInstance__topic1011000070">instancename</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListInstance__topic1011000072">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListInstance__topic1011000074">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListInstance__topic1011000076">Fuzzy query for dedicated WAF engine names. Only prefix and suffix match query are supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstance__topic1011000077"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListInstance__topic1011000086"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListInstance__topic1011000088">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListInstance__topic1011000090">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListInstance__topic1011000092">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListInstance__topic1011000094">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListInstance__topic1011000098">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListInstance__topic1011000100">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListInstance__topic1011000102">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListInstance__topic1011000104">User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
</td>
</tr>
<tr id="ListInstance__topic1011000105"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListInstance__topic1011000107">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListInstance__topic1011000109">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListInstance__topic1011000111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListInstance__topic1011000113">Content-Type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstance__topic1011000114"><h4 class="sectiontitle">Response Parameters</h4><p id="ListInstance__topic1011000116"><strong id="ListInstance__topic1011000117">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__response_ListInstanceResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListInstance__topic1011000124"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListInstance__topic1011000126">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListInstance__topic1011000128">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListInstance__topic1011000130">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000132"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstance__topic1011000134">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstance__topic1011000136">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstance__topic1011000138">Total number of dedicated engines</p>
</td>
</tr>
<tr id="ListInstance__topic1011000139"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstance__topic1011000141">purchased</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstance__topic1011000143">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstance__topic1011000145">Whether any dedicated engine has been created. This parameter is reserved and can be ignored currently. The value can be false or true.</p>
<ul id="ListInstance__topic1011000146"><li id="ListInstance__topic1011000147"><p id="ListInstance__topic1011000148"><a name="ListInstance__topic1011000147"></a><a name="topic1011000147"></a>false: No dedicated WAF engine has been created.</p>
</li><li id="ListInstance__topic1011000149"><p id="ListInstance__topic1011000150"><a name="ListInstance__topic1011000149"></a><a name="topic1011000149"></a>true: At least one dedicated WAF engine has been created.</p>
</li></ul>
</td>
</tr>
<tr id="ListInstance__topic1011000151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListInstance__topic1011000153">items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListInstance__topic1011000155">Array of <a href="#ListInstance__response_ListInstance">ListInstance</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListInstance__topic1011000158">Details about the dedicated engine</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstance__response_ListInstance"></a><a name="response_ListInstance"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__response_ListInstance" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ListInstance</caption><thead align="left"><tr id="ListInstance__topic1011000165"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListInstance__topic1011000167">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListInstance__topic1011000169">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListInstance__topic1011000171">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000173"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000175">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000177">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000179">ID of the dedicated WAF engine</p>
</td>
</tr>
<tr id="ListInstance__topic1011000180"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000182">instancename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000184">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000186">Name of the dedicated WAF engine. This parameter is repeated and can be ignored.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000187"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000189">region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000191">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000193">Region where a dedicated engine is to be created. Its value is EU-DE.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000194"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000196">zone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000198">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000200">available_zone ID.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000201"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000203">arch</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000205">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000207">CPU architecture</p>
</td>
</tr>
<tr id="ListInstance__topic1011000208"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000210">cpu_flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000212">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000214">ECS specifications and the dedicated WAF instance specifications. You can view details about the supported specifications on the WAF console.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000215"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000217">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000219">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000221">ID of the VPC where the dedicated engine is located</p>
</td>
</tr>
<tr id="ListInstance__topic1011000222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000224">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000226">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000228">Subnet ID of the VPC where the dedicated engine is located.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000229"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000231">service_ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000233">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000235">Service plane IP address of the dedicated engine</p>
</td>
</tr>
<tr id="ListInstance__topic1011000236"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000238">service_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000240">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000242">IPv6 address of the dedicated WAF instance on the service plane. This parameter is displayed when <strong id="ListInstance__topic1011000243">ipv6_enable</strong> is set to <strong id="ListInstance__topic1011000244">true</strong>.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000247">security_group_ids</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000249">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000251">Security groups bound to the dedicated engine ECS</p>
</td>
</tr>
<tr id="ListInstance__topic1011000252"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000254">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000256">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000258">Billing status of dedicated WAF engine. The value can be 0, 1, or 2.</p>
<ul id="ListInstance__topic1011000259"><li id="ListInstance__topic1011000260"><p id="ListInstance__topic1011000261"><a name="ListInstance__topic1011000260"></a><a name="topic1011000260"></a>0: The billing is normal.</p>
</li><li id="ListInstance__topic1011000262"><p id="ListInstance__topic1011000263"><a name="ListInstance__topic1011000262"></a><a name="topic1011000262"></a>1: The billing account is frozen. Resources and data will be retained, but the cloud services cannot be used by the account.</p>
</li><li id="ListInstance__topic1011000264"><p id="ListInstance__topic1011000265"><a name="ListInstance__topic1011000264"></a><a name="topic1011000264"></a>2: The billing is terminated. Resources and data will be cleared.</p>
</li></ul>
</td>
</tr>
<tr id="ListInstance__topic1011000266"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000268">run_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000270">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000272">Running status of the dedicated engine. The value can be 0 (creating), 1 (running), 2 (deleting), 3 (deleted), 4 (creation failed), 5 (frozen), 6 (abnormal), 7 (updating), or 8 (update failed).</p>
</td>
</tr>
<tr id="ListInstance__topic1011000273"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000275">access_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000277">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000279">Access status of the dedicated engine. The value can be 0 or 1.</p>
<ul id="ListInstance__topic1011000280"><li id="ListInstance__topic1011000281"><p id="ListInstance__topic1011000282"><a name="ListInstance__topic1011000281"></a><a name="topic1011000281"></a>0: the dedicated engine is not connected.</p>
</li><li id="ListInstance__topic1011000283"><p id="ListInstance__topic1011000284"><a name="ListInstance__topic1011000283"></a><a name="topic1011000283"></a>1: the dedicated engine is connected.</p>
</li></ul>
</td>
</tr>
<tr id="ListInstance__topic1011000285"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000287">upgradable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000289">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000291">Whether the dedicated engine can be upgraded.</p>
<ul id="ListInstance__topic1011000292"><li id="ListInstance__topic1011000293"><p id="ListInstance__topic1011000294"><a name="ListInstance__topic1011000293"></a><a name="topic1011000293"></a>0: the dedicated engine is non-upgradable</p>
</li><li id="ListInstance__topic1011000295"><p id="ListInstance__topic1011000296"><a name="ListInstance__topic1011000295"></a><a name="topic1011000295"></a>1: the dedicated engine is upgradable</p>
</li></ul>
</td>
</tr>
<tr id="ListInstance__topic1011000297"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000299">cloudServiceType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000301">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000303">Cloud service code. This is a unique code used to distinguish cloud services from each other. You can ignore it.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000304"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000306">resourceType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000308">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000310">Cloud service resource type. Cloud services are purchased by resource type. You can ignore it.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000313">resourceSpecCode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000315">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000317">Resource specifications code. This code is used to identify the resource specifications the dedicated engine uses. You can ignore it.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000320">specification</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000322">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000324">Dedicated engine ECS specifications, for example, 8 vCPUs | 16 GB. 8vCPUs | 16GB maps to waf.instance.enterprise, and 2vCPUs | 4GB to waf.instance. professional.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000325"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000327">hosts</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000329">Array of <a href="#ListInstance__response_IdHostnameEntry">IdHostnameEntry</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000332">Domain name protected by the dedicated engine.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000333"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000335">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000337">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000339">ID of the ECS hosting the dedicated engine.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000340"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000342">serverId</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000344">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000346">ID of the ECS housing the dedicated engine. This parameter can be ignored because it is the same as <strong id="ListInstance__topic1011000347">server_id</strong>.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000348"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000350">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000352">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000354">Timestamp when the dedicated WAF engine was created.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000355"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000357">data_volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000359">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000361">Size of the data disk, in GB.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000362"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000364">res_tenant_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000366">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000368">Type of the dedicated WAF instance. Its value is always <strong id="ListInstance__topic1011000369">1</strong>, which means the type of the dedicated WAF instance is <strong id="ListInstance__topic1011000370">Network Interface</strong>.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000371"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000373">latest_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000375">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000377">Previous version of the dedicated engine</p>
</td>
</tr>
<tr id="ListInstance__topic1011000378"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListInstance__topic1011000380">current_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListInstance__topic1011000382">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListInstance__topic1011000384">Current version of the dedicated engine</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListInstance__response_IdHostnameEntry"></a><a name="response_IdHostnameEntry"></a><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__response_IdHostnameEntry" frame="border" border="1" rules="all"><caption><b>Table 6 </b>IdHostnameEntry</caption><thead align="left"><tr id="ListInstance__topic1011000391"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListInstance__topic1011000393">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListInstance__topic1011000395">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListInstance__topic1011000397">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000399"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstance__topic1011000401">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstance__topic1011000403">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstance__topic1011000405">ID of the protected domain name. This is a unique ID automatically generated by the system.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000406"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListInstance__topic1011000408">hostname</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListInstance__topic1011000410">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListInstance__topic1011000412">Protected domain name</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstance__topic1011000413"><strong id="ListInstance__topic1011000414">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__response_RestErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListInstance__topic1011000421"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ListInstance__topic1011000423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ListInstance__topic1011000425">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ListInstance__topic1011000427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000429"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListInstance__topic1011000431">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListInstance__topic1011000433">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListInstance__topic1011000435">Error code</p>
</td>
</tr>
<tr id="ListInstance__topic1011000436"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListInstance__topic1011000438">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListInstance__topic1011000440">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListInstance__topic1011000442">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstance__topic1011000443"><strong id="ListInstance__topic1011000444">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__response_RestErrorResponse_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListInstance__topic1011000451"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="ListInstance__topic1011000453">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="ListInstance__topic1011000455">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="ListInstance__topic1011000457">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000459"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListInstance__topic1011000461">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListInstance__topic1011000463">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListInstance__topic1011000465">Error code</p>
</td>
</tr>
<tr id="ListInstance__topic1011000466"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListInstance__topic1011000468">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListInstance__topic1011000470">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListInstance__topic1011000472">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListInstance__topic1011000473"><strong id="ListInstance__topic1011000474">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__response_RestErrorResponse_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListInstance__topic1011000481"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.1"><p id="ListInstance__topic1011000483">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.2"><p id="ListInstance__topic1011000485">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.11.2.4.1.3"><p id="ListInstance__topic1011000487">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000489"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ListInstance__topic1011000491">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ListInstance__topic1011000493">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ListInstance__topic1011000495">Error code</p>
</td>
</tr>
<tr id="ListInstance__topic1011000496"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ListInstance__topic1011000498">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ListInstance__topic1011000500">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ListInstance__topic1011000502">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstance__topic1011000503"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListInstance__topic1011000505">GET https://{endpoint}/v1/{project_id}/premium-waf/instance</pre>
</div>
<div class="section" id="ListInstance__topic1011000506"><h4 class="sectiontitle">Example Responses</h4><p id="ListInstance__topic1011000508"><strong id="ListInstance__topic1011000509">Status code: 200</strong></p>
<p id="ListInstance__topic1011000510">Lists of dedicated WAF engines</p>
<pre class="screen" id="ListInstance__topic1011000511">{
"purchased" : true,
"total" : 1,
"items" : [ {
"id" : "0619871acb764d48a112695e8f7cbb10",
"region" : "region-01-7",
"zone" : "region-01-7a",
"specification" : "8vCPUs | 16GB",
"arch" : "x86",
"upgradable" : 0,
"status" : 0,
"serverId" : "477353dc-8687-4bf4-b45b-1d7fee74fa63",
"server_id" : "477353dc-8687-4bf4-b45b-1d7fee74fa63",
"cloudServiceType" : "hws.service.type.waf",
"resourceType" : "hws.resource.type.waf.instance",
"resourceSpecCode" : "waf.instance.enterprise",
"vpc_id" : "13718074-a3f9-408d-82aa-3c41ef55e589",
"subnet_id" : "74d1b5a6-c7eb-4e9a-8372-181212552fcc",
"service_ip" : "192.168.10.68",
"security_group_ids" : [ "34287bdb-7aba-471a-b041-27427f1af76a" ],
"cpu_flavor" : "Si2.2xlarge.2",
"run_status" : 2,
"access_status" : 1,
"hosts" : [ {
"id" : "c3be17bbe3a641c7a1ded6019c377402",
"hostname" : "demo.www.com"
} ],
"latest_version" : 202401,
"current_version" : 202403,
"instance_name" : "0412elb",
"create_time" : 1649217360674
} ]
}</pre>
</div>
<div class="section" id="ListInstance__topic1011000512"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListInstance__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListInstance__topic1011000518"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListInstance__topic1011000520">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListInstance__topic1011000522">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListInstance__topic1011000524"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstance__topic1011000526">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstance__topic1011000528">Lists of dedicated WAF engines</p>
</td>
</tr>
<tr id="ListInstance__topic1011000529"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstance__topic1011000531">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstance__topic1011000533">Request failed.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000534"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstance__topic1011000536">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstance__topic1011000538">The token does not have required permissions.</p>
</td>
</tr>
<tr id="ListInstance__topic1011000539"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListInstance__topic1011000541">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListInstance__topic1011000543">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListInstance__topic1011000544"><h4 class="sectiontitle">Error Codes</h4><p id="ListInstance__topic1011000546">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_300000000.html">Dedicated Instance Management</a></div>
</div>
</div>
View Git Blame Copy Permalink