forked from docs/doc-exports
Zaoxu, Li
eda4b9181d
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>
175 lines
13 KiB
HTML
175 lines
13 KiB
HTML
<a name="as_06_0106"></a><a name="as_06_0106"></a>
|
|
|
|
<h1 class="topictitle1">Enabling or Disabling an AS Group</h1>
|
|
<div id="body16190202"><div class="section" id="as_06_0106__section44766395"><h4 class="sectiontitle">Function</h4><p id="as_06_0106__p36337966">This interface is used to enable or disable a specified AS group.</p>
|
|
<div class="note" id="as_06_0106__note1994816481431"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="as_06_0106__p43433751171011">For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an in-progress scaling action, the scaling action does not stop immediately after the AS group is disabled.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section244376"><h4 class="sectiontitle">URI</h4><p id="as_06_0106__p42712676">POST /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0106__table37174709" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="as_06_0106__row12886548"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.3.2.5.1.1"><p id="as_06_0106__p37177477"><strong id="as_06_0106__b5958142010398">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.2"><p id="as_06_0106__p58585662">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.3"><p id="as_06_0106__p47818216">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_0106__p48070315"><strong id="as_06_0106__b787972220392">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0106__row1381422"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0106__p44786329">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0106__p3814037">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0106__p40501577">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0106__p36520930">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row64858964"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0106__p19084765">scaling_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0106__p2362138">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0106__p57115508">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0106__p62953426">Specifies the AS group ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section2199391"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0106__table42688671" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="as_06_0106__row6074405"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.2.2.5.1.1"><p id="as_06_0106__p22264835"><strong id="as_06_0106__b16457182313913">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.588235294117645%" id="mcps1.3.3.2.2.5.1.2"><p id="as_06_0106__p58621221">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.627450980392158%" id="mcps1.3.3.2.2.5.1.3"><p id="as_06_0106__p50698484">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.17647058823529%" id="mcps1.3.3.2.2.5.1.4"><p id="as_06_0106__p12936535"><strong id="as_06_0106__b5634152410396">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0106__row41226423"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.2.2.5.1.1 "><p id="as_06_0106__p51005947">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.588235294117645%" headers="mcps1.3.3.2.2.5.1.2 "><p id="as_06_0106__p37841036">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.627450980392158%" headers="mcps1.3.3.2.2.5.1.3 "><p id="as_06_0106__p45225041">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.17647058823529%" headers="mcps1.3.3.2.2.5.1.4 "><p id="as_06_0106__p3552977619244">Specifies a flag for enabling or disabling an AS group.</p>
|
|
<ul id="as_06_0106__ul6530813782310"><li id="as_06_0106__li497062282310"><strong id="as_06_0106__b84235270617755">resume</strong>: enables the AS group.</li><li id="as_06_0106__li6445314582310"><strong id="as_06_0106__b8423527061784">pause</strong>: disables the AS group.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section1412165513342"><h4 class="sectiontitle">Example Request</h4><ul id="as_06_0106__ul3984193016361"><li id="as_06_0106__li398412303367">This example enables the AS group with ID <strong id="as_06_0106__b2615738097">a8327883-6b07-4497-9c61-68d03ee193a1</strong>.<pre class="screen" id="as_06_0106__screen090213268367">POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action
|
|
|
|
{
|
|
"action": "resume"
|
|
}</pre>
|
|
</li><li id="as_06_0106__li19528183393617">This example disables the AS group with ID <strong id="as_06_0106__b1944910214102">a8327883-6b07-4497-9c61-68d03ee193a1</strong>.<pre class="screen" id="as_06_0106__screen16425185162013">POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action
|
|
|
|
{
|
|
"action": "pause"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section19794519"><h4 class="sectiontitle">Response</h4><p id="as_06_0106__p60400126203515">None</p>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section1686211410358"><h4 class="sectiontitle">Example Response</h4><p id="as_06_0106__p15614505203519">None</p>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section43932946"><h4 class="sectiontitle">Returned Values</h4><ul id="as_06_0106__ul7204610"><li id="as_06_0106__li64841498">Normal<p id="as_06_0106__p46702574"><a name="as_06_0106__li64841498"></a><a name="li64841498"></a>204</p>
|
|
</li><li id="as_06_0106__li17669982">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0106__table24812117" frame="border" border="1" rules="all"><thead align="left"><tr id="as_06_0106__row10022287"><th align="left" class="cellrowborder" valign="top" width="43.61%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="as_06_0106__p6498885">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.38999999999999%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="as_06_0106__p56647676">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0106__row25059035"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p16515979">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p62725940">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row27662549"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p26073957">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p31615745">You must enter the username and password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row16106256"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p29538346">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p43795845">You are forbidden to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row58618290"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p50461073">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p60815108">The server could not find the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row10465065"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p42363926">405 Method Not Allowed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p8925963">You are not allowed to use the method specified in the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row13224809"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p64576574">406 Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p63319983">The response generated by the server could not be accepted by the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row33008942"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p56478678">407 Proxy Authentication Required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p11370190">You must use the proxy server for authentication to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row35222847"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p34478387">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p41285963">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row36029352"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p32696434">409 Conflict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p31165525">The request could not be processed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row12054271"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p36871865">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p33831071">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row36044191"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p33898355">501 Not Implemented</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p61412264">Failed to complete the request because the server does not support the requested function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row15839470"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p7928727">502 Bad Gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p38247156">Failed to complete the request because the request is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row8680090"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p31998689">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p41757008">Failed to complete the request because the system is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0106__row40268759"><td class="cellrowborder" valign="top" width="43.61%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0106__p40544022">504 Gateway Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.38999999999999%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0106__p62840338">A gateway timeout error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="as_06_0106__section17669131616110"><h4 class="sectiontitle">Error Codes</h4><p id="as_06_0106__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>
|
|
|