vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/as/api-ref/as_06_0103.html
Zaoxu, Li eda4b9181d AS API DOC 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-09-19 11:04:13 +00:00

527 lines
39 KiB
HTML
Raw Blame History

<a name="as_06_0103"></a><a name="as_06_0103"></a>
<h1 class="topictitle1">Querying an AS Group</h1>
<div id="body28618347"><div class="section" id="as_06_0103__section37186555"><h4 class="sectiontitle">Function</h4><p id="as_06_0103__p36384783">This API is used to query details about a specified AS group by group ID.</p>
</div>
<div class="section" id="as_06_0103__section66243540"><h4 class="sectiontitle">URI</h4><p id="as_06_0103__p61882154">GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table46398558" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="as_06_0103__row27278612"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.2.3.2.5.1.1"><p id="as_06_0103__p62083996"><strong id="as_06_0103__b174791413163714">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.5.1.2"><p id="as_06_0103__p62747764">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.5.1.3"><p id="as_06_0103__p49404100">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.2.3.2.5.1.4"><p id="as_06_0103__p42309173"><strong id="as_06_0103__b96121414103711">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__row4490990"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0103__p28225944">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0103__p4600155">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0103__p37068254">String</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0103__p36520930">Specifies the project ID.</p>
</td>
</tr>
<tr id="as_06_0103__row44993941"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0103__p20630641">scaling_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0103__p60469192">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0103__p66166404">String</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0103__p57878541">Specifies the AS group ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="as_06_0103__section59320951"><h4 class="sectiontitle">Request</h4><p id="as_06_0103__p60400126203515">None</p>
</div>
<div class="section" id="as_06_0103__section1532417672718"><h4 class="sectiontitle">Example Request</h4><p id="as_06_0103__p15614505203519">This example queries the details about the AS group with ID <strong id="as_06_0103__b76351757182616">d4e50321-3777-4135-97f8-9f5e9714a4b0</strong>.</p>
<pre class="screen" id="as_06_0103__screen7187135561819">GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0</pre>
</div>
<div class="section" id="as_06_0103__section64126518"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table24727624" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="as_06_0103__row15561779"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.2.4.1.1"><p id="as_06_0103__p52544597"><strong id="as_06_0103__b587131633710">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.2.4.1.2"><p id="as_06_0103__p28253988">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.5.2.2.4.1.3"><p id="as_06_0103__p6871687"><strong id="as_06_0103__b965714185377">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__row19735783"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0103__p55094571">scaling_group</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0103__p33475260"><a href="#as_06_0103__table2571689984111">scaling_groups</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0103__p27141505">Specifies details about the AS group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="as_06_0103__table2571689984111"></a><a name="table2571689984111"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table2571689984111" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="as_06_0103__as_06_0102_b2616571020249">scaling_groups</strong> field description</caption><thead align="left"><tr id="as_06_0103__as_06_0102_row3125168495816"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.5.3.2.4.1.1"><p id="as_06_0103__as_06_0102_p4835851595816"><strong id="as_06_0103__as_06_0102_b14507125433416">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.5.3.2.4.1.2"><p id="as_06_0103__as_06_0102_p2472567595816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.5.3.2.4.1.3"><p id="as_06_0103__as_06_0102_p5662264395816"><strong id="as_06_0103__as_06_0102_b966010563343">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__as_06_0102_row2303134795816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p5359982895816">scaling_group_name</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p4661881395816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p1802754395816">Specifies the name of the AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row2803016695816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p5585097295816">scaling_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p2763485495816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p2383068495816">Specifies the AS group ID.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row1314957295816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p5848240895816">scaling_group_status</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p3945463795816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p4170905195816">Specifies the AS group status.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row3983714095816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p558291395816">scaling_configuration_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p4956282795816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p5516604195816">Specifies the AS configuration ID.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row2673232595816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p1783474195816">scaling_configuration_name</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p3532793495816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p4299037595816">Specifies the AS configuration name.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row5136905595816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p14389995816">current_instance_number</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p1165588495816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p460258695816">Specifies the number of current instances in the AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row4142327995816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p6695131595816">desire_instance_number</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p5434739895816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p4006315595816">Specifies the expected number of instances in the AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row2502407895816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p1368441895816">min_instance_number</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p3469606795816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p5891800895816">Specifies the minimum number of instances in the AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row6050002595816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p155503295816">max_instance_number</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p5884880095816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p202348095816">Specifies the maximum number of instances in the AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row1821132195816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p6583092595816">cool_down_time</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p3070470995816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p405351495816">Specifies the cooldown period (s).</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row3648162895816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p222191995816">lb_listener_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p4575773095816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p1538862195816">Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row33800908174636"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p53519047174636">lbaas_listeners</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p1966763821113">Array of <a href="as_06_0102.html#as_06_0102__table62452402171652">lbaas_listeners</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p24895134174636">Specifies enhanced load balancers. For details, see <a href="as_06_0102.html#as_06_0102__table62452402171652">Table 4</a>.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row30423366112250"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p48373547112250">available_zones</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p117221011175115">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p21025459112250">Specifies the AZ information.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row427986595816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p1112482195816">networks</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p347824310372">Array of <a href="as_06_0102.html#as_06_0102__t67e1f67cb70d4457bab7efeb3dfeee6e">networks</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p4800004895816">Specifies the network information. For details, see <a href="as_06_0102.html#as_06_0102__t67e1f67cb70d4457bab7efeb3dfeee6e">Table 5</a>.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row2934724995816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p2831697495816">security_groups</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p5722151135117">Array of <a href="as_06_0102.html#as_06_0102__t3db1c8f5898a4179b5029204834c82e5">security_groups</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p458485895816">Specifies the security group information. For details, see <a href="as_06_0102.html#as_06_0102__t3db1c8f5898a4179b5029204834c82e5">Table 7</a>.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row4126372995816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p5402772895816">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p1416983695816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p690602895816">Specifies the time when an AS group was created. The time format complies with UTC.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row6215425395816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p132972795816">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p4059904995816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p18869295816">Specifies the ID of the VPC to which the AS group belongs.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row169823395816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p333920895816">detail</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p204042795816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p3105690795816">Specifies details about the AS group. If a scaling action fails, this parameter is used to record errors.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row1107670995816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p2479821895816">is_scaling</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p6249865695816">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p2922638295816">Specifies the scaling flag of the AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row6171085495816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p3252330995816">health_periodic_audit_method</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p1714233595816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p4635191095816">Specifies the health check method.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row1451401395816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p3478441495816">health_periodic_audit_time</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p6607415195816">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p5040604995816">Specifies the health check interval.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row42331571153426"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p6305198153426">health_periodic_audit_grace_period</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p40959034153426">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p29347454153426">Specifies the grace period for health check.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row5100126495816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p3746171895816">instance_terminate_policy</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p1450028895816">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p3367266295816">Specifies the instance removal policy.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row3461851095816"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p5263592295816">notifications</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p3565131995816">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p207574995816">Specifies the notification mode.</p>
<p id="as_06_0103__as_06_0102_p1868174295816"><strong id="as_06_0103__as_06_0102_b58832166171917">EMAIL</strong> refers to notification by email.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row58376155111614"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p30848135111614">delete_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p40568935111649">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p64858299111649">Specifies whether to delete the EIP bound to the ECS when deleting the ECS.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row1666213536250"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p1585114581258">delete_volume</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p19851458122520">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p178519586250">Specifies whether to delete the data disks attached to the ECS when deleting the ECS.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row50398037163752"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p55709224163752">cloud_location_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p16153275163752">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p33346870163752">This parameter is reserved.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row529918693932"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p2658093993932">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p557242093932">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p4871283793932">Specifies the enterprise project ID.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row870025345713"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p67015533576">activity_type</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p14701185316570">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p16701185365719">Specifies the type of the AS action.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row9571105073212"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p1766414574320">multi_az_priority_policy</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p176649575326">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p1766565743214">Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row55201022191911"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.3.2.4.1.1 "><p id="as_06_0103__as_06_0102_p1487263123714">description</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.3.2.4.1.2 "><p id="as_06_0103__as_06_0102_p88721310372">String</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.5.3.2.4.1.3 "><p id="as_06_0103__as_06_0102_p18721315371">Specifies the description of the AS group.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table62452402171652" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="as_06_0103__as_06_0102_b6699296094725">lbaas_listeners</strong> field description</caption><thead align="left"><tr id="as_06_0103__as_06_0102_row45038761171652"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.5.4.2.4.1.1"><p id="as_06_0103__as_06_0102_p24261034171652"><strong id="as_06_0103__as_06_0102_b1882212592346">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.5.4.2.4.1.2"><p id="as_06_0103__as_06_0102_p61530925171652">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.5.4.2.4.1.3"><p id="as_06_0103__as_06_0102_p17949056171652"><strong id="as_06_0103__as_06_0102_b1486304193518">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__as_06_0102_row44587411171652"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0103__as_06_0102_p54810510171652">listener_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0103__as_06_0102_p42466398171652">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0103__as_06_0102_p17226243171652">Specifies the listener ID.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row16035310115445"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0103__as_06_0102_p239701115447">pool_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0103__as_06_0102_p19415824115447">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0103__as_06_0102_p14598635115447">Specifies the backend ECS group ID.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row61114407171742"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0103__as_06_0102_p51319960171742">protocol_port</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0103__as_06_0102_p25093240171742">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0103__as_06_0102_p19286583171742">Specifies the backend protocol port, which is the port on which a backend ECS listens for traffic.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row36552334171745"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.4.2.4.1.1 "><p id="as_06_0103__as_06_0102_p7949116171745">weight</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.4.2.4.1.2 "><p id="as_06_0103__as_06_0102_p10566861171745">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.4.2.4.1.3 "><p id="as_06_0103__as_06_0102_p50609408171745">Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table125932828469" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="as_06_0103__as_06_0102_b2453348094725">networks</strong> field description</caption><thead align="left"><tr id="as_06_0103__as_06_0102_r38fbfd545d8b41ac9a165cb5b185293c"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.5.5.2.4.1.1"><p id="as_06_0103__as_06_0102_a25948832a6e540e4aeaf9201f17c6136"><strong id="as_06_0103__as_06_0102_b16850768358">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.5.5.2.4.1.2"><p id="as_06_0103__as_06_0102_a5fa8352938e048e29a2a0ae3465f8beb">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.5.5.2.4.1.3"><p id="as_06_0103__as_06_0102_abe4729b8fced431487d765209a10d998"><strong id="as_06_0103__as_06_0102_b699417913511">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__as_06_0102_rc7ffdcdeb84a45feb1ea195ba834fbfd"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.5.2.4.1.1 "><p id="as_06_0103__as_06_0102_a7d60ed8df47c4992a324abe8c0284e98">id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.5.2.4.1.2 "><p id="as_06_0103__as_06_0102_a0c27097a7a204f7f8b84faf6c4ace52c">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.5.2.4.1.3 "><p id="as_06_0103__as_06_0102_a449a6776950944bda68da138e6abe695">Specifies the subnet ID.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row225972616103"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.5.2.4.1.1 "><p id="as_06_0103__as_06_0102_p168461419171814">ipv6_enable</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.5.2.4.1.2 "><p id="as_06_0103__as_06_0102_p128463194182">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.5.2.4.1.3 "><p id="as_06_0103__as_06_0102_p1869495520194">Specifies whether to support IPv6 addresses. If this parameter is set to <strong id="as_06_0103__as_06_0102_b28331146153114">true</strong>, the NIC supports IPv6 addresses. The default value is <strong id="as_06_0103__as_06_0102_b8423527060277">false</strong>. This parameter is reserved.</p>
</td>
</tr>
<tr id="as_06_0103__as_06_0102_row10392255147"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.5.5.2.4.1.1 "><p id="as_06_0103__as_06_0102_p205431522101813">ipv6_bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.5.5.2.4.1.2 "><p id="as_06_0103__as_06_0102_p571213113810"><a href="as_06_0102.html#as_06_0102__table165325426371">ipv6_bandwidth</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.5.5.2.4.1.3 "><p id="as_06_0103__as_06_0102_p18543162219184">Specifies the shared bandwidth of an IPv6 address. This parameter is left blank by default, indicating that no IPv6 shared bandwidth is bound. This parameter is reserved.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table12158109202914" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="as_06_0103__as_06_0102_b11434927124213">ipv6_bandwidth</strong> field description</caption><thead align="left"><tr id="as_06_0103__as_06_0102_row1853319428379"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.5.6.2.4.1.1"><p id="as_06_0103__as_06_0102_p18442811162111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.6.2.4.1.2"><p id="as_06_0103__as_06_0102_p651421810389">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.5.6.2.4.1.3"><p id="as_06_0103__as_06_0102_p444917113212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__as_06_0102_row1853324213378"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.5.6.2.4.1.1 "><p id="as_06_0103__as_06_0102_p109011143210">id</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.6.2.4.1.2 "><p id="as_06_0103__as_06_0102_p59010416217">String</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.5.6.2.4.1.3 "><p id="as_06_0103__as_06_0102_p18389161592217">Specifies the ID of the shared bandwidth of an IPv6 address. This parameter is reserved.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="as_06_0103__section1535394822716"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="as_06_0103__screen573896392941">{
"scaling_group": {
"networks": [
{
"id": " a8327883-6b07-4497-9c61-68d03ee193a ",
"ipv6_enable": true,
"ipv6_bandwidth":
{
"id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5"
}
}
],
"available_zones": [
"XXXa",
"XXXb"
],
"detail": null,
"scaling_group_name": "api_gateway_modify",
"scaling_group_id": "d4e50321-3777-4135-97f8-9f5e9714a4b0",
"scaling_group_status": "INSERVICE",
"scaling_configuration_id": "53579851-3841-418d-a97b-9cecdb663a90",
"scaling_configuration_name": "press",
"current_instance_number": 7,
"desire_instance_number": 8,
"min_instance_number": 0,
"max_instance_number": 100,
"cool_down_time": 900,
"lb_listener_id": null,
"security_groups": [
{
"id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab"
}
],
"create_time": "2015-09-01T08:36:10Z",
"vpc_id": "3e22f934-800d-4bb4-a588-0b9a76108190",
"health_periodic_audit_method": "NOVA_AUDIT",
"health_periodic_audit_time": 5,
"health_periodic_audit_grace_period": 600,
"instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
"is_scaling": true,
"delete_publicip": false,
"notifications": null,
"enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
"activity_type":"MODIFY_ELB",
"multi_az_priority_policy":"PICK_FIRST"
}
}</pre>
</div>
<div class="section" id="as_06_0103__section40267752"><h4 class="sectiontitle">Returned Values</h4><ul id="as_06_0103__ul8723262"><li id="as_06_0103__li11400497">Normal<p id="as_06_0103__p35495616"><a name="as_06_0103__li11400497"></a><a name="li11400497"></a>200</p>
</li><li id="as_06_0103__li51025090">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0103__table56572634" frame="border" border="1" rules="all"><thead align="left"><tr id="as_06_0103__row12476353"><th align="left" class="cellrowborder" valign="top" width="34%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="as_06_0103__p3951668">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="as_06_0103__p51649700">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0103__row22876152"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p41029017">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p35016046">The server failed to process the request.</p>
</td>
</tr>
<tr id="as_06_0103__row46708959"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p25329374">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p38413446">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="as_06_0103__row10176696"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p19006063">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p63096163">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="as_06_0103__row30994559"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p27531352">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p15447074">The server could not find the requested page.</p>
</td>
</tr>
<tr id="as_06_0103__row4805945"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p53737263">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p57751017">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="as_06_0103__row49997107"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p23233871">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p2895395">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="as_06_0103__row26058562"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p30368798">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p43953607">You must use the proxy server for authentication to process the request.</p>
</td>
</tr>
<tr id="as_06_0103__row60038148"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p31251786">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p48366737">The request timed out.</p>
</td>
</tr>
<tr id="as_06_0103__row32647452"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p27197959">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p55551046">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="as_06_0103__row30197369"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p30067794">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p19572211">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="as_06_0103__row41932174"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p41062959">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p37765421">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="as_06_0103__row4344474"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p16358126">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p49939793">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="as_06_0103__row46804961"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p33105505">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p64300229">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="as_06_0103__row41831152"><td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0103__p32880166">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0103__p46047796">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="as_06_0103__section17669131616110"><h4 class="sectiontitle">Error Codes</h4><p id="as_06_0103__p172692548116">See <a href="as_07_0102.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="as_06_0100.html">AS Groups</a></div>
</div>
</div>
View Git Blame Copy Permalink