doc-exports/docs/as/api-ref/as_06_0409.html
guoyanyan 31704f0318 as_api_0325
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-04-13 08:59:32 +00:00

418 lines
35 KiB
HTML

<a name="as_06_0409"></a><a name="as_06_0409"></a>
<h1 class="topictitle1">Querying an AS Policy (V2)</h1>
<div id="body1521704457471"><div class="section" id="as_06_0409__section16272157227"><h4 class="sectiontitle">Function</h4><p id="as_06_0409__p11639141542211">This API is used to query details about a specified AS policy by policy ID.</p>
<p id="as_06_0409__p8878424174617">The difference between the V2 and V1 APIs for querying details of an AS policy is that V2 contains scaling resource types in response messages.</p>
</div>
<div class="section" id="as_06_0409__section1057514299222"><h4 class="sectiontitle">URI</h4><p id="as_06_0409__p1860732918225">GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table18577192913227" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="as_06_0409__row460813297221"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.2.3.2.5.1.1"><p id="as_06_0409__p56081829132215"><strong id="as_06_0409__b98281234175817">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="as_06_0409__p66081294222"><strong id="as_06_0409__b842352706141528">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.5.1.3"><p id="as_06_0409__p66084294228"><strong id="as_06_0409__b84235270693914">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38%" id="mcps1.3.2.3.2.5.1.4"><p id="as_06_0409__p1460832962213"><strong id="as_06_0409__b6221937115820">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row136081329112212"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0409__p196081629142213">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0409__p12608129142214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0409__p66081029162214">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0409__p36520930">Specifies the project ID.</p>
</td>
</tr>
<tr id="as_06_0409__row2608152902220"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0409__p66086295221">scaling_policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0409__p126087293225">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0409__p17608029132210">String</p>
</td>
<td class="cellrowborder" valign="top" width="38%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0409__p13608929102216">Specifies the AS policy ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="as_06_0409__section15620184022220"><h4 class="sectiontitle">Request Message</h4><ul id="as_06_0409__ul9007507"><li id="as_06_0409__li56913160">Request parameters<p id="as_06_0409__p60400126203515"><a name="as_06_0409__li56913160"></a><a name="li56913160"></a>None</p>
</li><li id="as_06_0409__li3640858994017">Example request<p id="as_06_0409__p15614505203519"><a name="as_06_0409__li3640858994017"></a><a name="li3640858994017"></a>This example shows how to query details about the AS policy with ID <strong id="as_06_0409__b92105885015">906f73ff-56e8-41b2-a005-8157d0c60361</strong>.</p>
<pre class="screen" id="as_06_0409__screen170212238316">GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361</pre>
</li></ul>
</div>
<div class="section" id="as_06_0409__section271118558221"><h4 class="sectiontitle">Response Message</h4><ul id="as_06_0409__ul261256192216"><li id="as_06_0409__li76356202220">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table16716175516228" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="as_06_0409__row1568568220"><th align="left" class="cellrowborder" valign="top" width="26.507349265073493%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="as_06_0409__p7795617226"><strong id="as_06_0409__b194321438185819">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.44815518448155%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="as_06_0409__p27456142215"><strong id="as_06_0409__b1723947213">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.04449555044495%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="as_06_0409__p127115632214"><strong id="as_06_0409__b4305143925815">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row87175622210"><td class="cellrowborder" valign="top" width="26.507349265073493%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="as_06_0409__p11795622215">scaling_policy</p>
</td>
<td class="cellrowborder" valign="top" width="18.44815518448155%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="as_06_0409__a4c03d226ca78442f99e13b8d363cd51d"><a href="#as_06_0409__table10729655182210">scaling_policy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.04449555044495%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="as_06_0409__p671556172214">Specifies details about the AS policy. For details, see <a href="#as_06_0409__table10729655182210">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="as_06_0409__table10729655182210"></a><a name="table10729655182210"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table10729655182210" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="as_06_0409__b9119133331915">scaling_policy</strong> field description</caption><thead align="left"><tr id="as_06_0409__row971956152212"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="as_06_0409__p5785612215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.37%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="as_06_0409__p27155612214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.1%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="as_06_0409__p1277568221">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row13885612214"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p08205611223">scaling_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p2814561228">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p1481956112219">Specifies the scaling resource ID.</p>
</td>
</tr>
<tr id="as_06_0409__row178145692211"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p9875610228">scaling_resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p168165622218">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p08156182216">Specifies the scaling resource type.</p>
<ul id="as_06_0409__ul7825614222"><li id="as_06_0409__li1781156112218">AS group: <strong id="as_06_0409__b84235270691950">SCALING_GROUP</strong></li><li id="as_06_0409__li198155682211">Bandwidth: <strong id="as_06_0409__b8423527069204">BANDWIDTH</strong></li></ul>
</td>
</tr>
<tr id="as_06_0409__row38175619221"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p08115614223">scaling_policy_name</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p15865682217">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p5825692211">Specifies the AS policy name.</p>
<p id="as_06_0409__p121115239911">Supports fuzzy search. </p>
</td>
</tr>
<tr id="as_06_0409__row5818563229"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p48165662211">scaling_policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p4895612224">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p128145672211">Specifies the AS policy ID.</p>
</td>
</tr>
<tr id="as_06_0409__row108856172218"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p158105692217">policy_status</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p2895614224">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p118115618226">Specifies the AS policy status.</p>
<ul id="as_06_0409__ul6912561227"><li id="as_06_0409__li79205619226"><strong id="as_06_0409__b45761523105018">INSERVICE</strong>: The AS policy is enabled.</li><li id="as_06_0409__li1492563224"><strong id="as_06_0409__b17790122516505">PAUSED</strong>: The AS policy is disabled.</li><li id="as_06_0409__li11955613228"><strong id="as_06_0409__b842352706171746">EXECUTING</strong>: The AS policy is being executed.</li></ul>
</td>
</tr>
<tr id="as_06_0409__row139175613226"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p14925611228">scaling_policy_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p2935615225">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p18912563224">Specifies the AS policy type.</p>
<ul id="as_06_0409__ul5935652220"><li id="as_06_0409__li8945662215"><strong>ALARM</strong>: indicates that the scaling action is triggered by an alarm. A value is returned for <strong>alarm_id</strong>, and no value is returned for <strong>scheduled_policy</strong>.</li><li id="as_06_0409__li159125616227"><strong id="as_06_0409__b842352706174318">SCHEDULED</strong>: indicates that the scaling action is triggered as scheduled. A value is returned for <strong id="as_06_0409__b842352706174359">scheduled_policy</strong>, and no value is returned for <strong id="as_06_0409__b842352706174456">alarm_id</strong>, <strong id="as_06_0409__b84235270617451">recurrence_type</strong>, <strong id="as_06_0409__b84235270617457">recurrence_value</strong>, <strong id="as_06_0409__b842352706174512">start_time</strong>, or <strong id="as_06_0409__b842352706174516">end_time</strong>.</li><li id="as_06_0409__li49956142218"><strong id="as_06_0409__b1053082523">RECURRENCE</strong>: indicates that the scaling action is triggered periodically. Values are returned for <strong id="as_06_0409__b51836550">scheduled_policy</strong>, <strong id="as_06_0409__b1121671907174638">recurrence_type</strong>, <strong id="as_06_0409__b413073752174638">recurrence_value</strong>, <strong id="as_06_0409__b1481332545174638">start_time</strong>, and <strong id="as_06_0409__b331387069174638">end_time</strong>, and no value is returned for <strong id="as_06_0409__b1706534044">alarm_id</strong>.</li></ul>
</td>
</tr>
<tr id="as_06_0409__row9917562220"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p18915692212">alarm_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p15913563226">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p14995642215">Specifies the alarm ID.</p>
</td>
</tr>
<tr id="as_06_0409__row139135616226"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p091956172215">scheduled_policy</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p174311737576"><a href="#as_06_0409__table179725552211">scheduled_policy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p1891456122210">Specifies the periodic or scheduled AS policy. For details, see <a href="#as_06_0409__table179725552211">Table 4</a>.</p>
</td>
</tr>
<tr id="as_06_0409__row89556122216"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p10995610224">scaling_policy_action</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p167395571418"><a href="#as_06_0409__table483105512229">scaling_policy_action</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p1710155610222">Specifies the scaling action of the AS policy. For details, see <a href="#as_06_0409__table483105512229">Table 5</a>.</p>
</td>
</tr>
<tr id="as_06_0409__row210556142211"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p610185652215">cool_down_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p1110756102219">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p1510156162210">Specifies the cooldown period (s).</p>
</td>
</tr>
<tr id="as_06_0409__row19101556112214"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p810175619222">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p1210115611229">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p21014567224">Specifies the time when an AS policy was created. The time format complies with UTC.</p>
</td>
</tr>
<tr id="as_06_0409__row8280367175820"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p65915113175834">meta_data</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p1011216376436"><a href="#as_06_0409__table14568680175854">meta_data</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p41667816175834">Provides additional information. For details, see <a href="#as_06_0409__table14568680175854">Table 6</a>.</p>
</td>
</tr>
<tr id="as_06_0409__row986715258320"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="as_06_0409__p5753132773220">description</p>
</td>
<td class="cellrowborder" valign="top" width="18.37%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="as_06_0409__p11753527153212">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.1%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="as_06_0409__p187541627193217">Specifies the AS policy description.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="as_06_0409__table179725552211"></a><a name="table179725552211"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table179725552211" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="as_06_0409__b18469164912194">scheduled_policy</strong> field description</caption><thead align="left"><tr id="as_06_0409__row511155632217"><th align="left" class="cellrowborder" valign="top" width="26.26%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="as_06_0409__p511556192217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="as_06_0409__p181195611223">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="as_06_0409__p811195610228">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row1811175662215"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_0409__p91125617222">launch_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_0409__p16111756162215">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_0409__p191175610221">Specifies the time when the scaling action is triggered. The time format complies with UTC.</p>
<ul id="as_06_0409__ul41112567221"><li id="as_06_0409__li141111568228">If <strong>scaling_policy_type</strong> is set to <strong>SCHEDULED</strong>, the time format is <strong>YYYY-MM-DDThh:mmZ</strong>.</li><li id="as_06_0409__li141195642215">If <strong>scaling_policy_type</strong> is set to <strong>RECURRENCE</strong>, the time format is <strong>hh:mm</strong>.</li></ul>
</td>
</tr>
<tr id="as_06_0409__row91175618225"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_0409__p1411155662212">recurrence_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_0409__p1611205612226">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_0409__p0110564224">Specifies the type of a periodically triggered scaling action.</p>
<ul id="as_06_0409__ul750792918211"><li id="as_06_0409__li15078291621"><strong>Daily</strong>: indicates that the scaling action is triggered once a day.</li><li id="as_06_0409__li65074298212"><strong>Weekly</strong>: indicates that the scaling action is triggered once a week.</li><li id="as_06_0409__li3507129623"><strong>Monthly</strong>: indicates that the scaling action is triggered once a month.</li></ul>
</td>
</tr>
<tr id="as_06_0409__row16141569226"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_0409__p181417563221">recurrence_value</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_0409__p2014125632212">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_0409__p2014956162216">Specifies the frequency at which scaling actions are triggered.</p>
<ul id="as_06_0409__ul201465692212"><li id="as_06_0409__li1714056112211">If <strong>recurrence_type</strong> is set to <strong>Daily</strong>, the value is <strong>null</strong>, indicating that the scaling action is triggered once a day.</li><li id="as_06_0409__li314756192220">If <strong id="as_06_0409__b43523467503">recurrence_type</strong> is set to <strong id="as_06_0409__b1235304612502">Weekly</strong>, the value ranges from <strong id="as_06_0409__b63531946205014">1</strong> (Sunday) to <strong id="as_06_0409__b10354646145016">7</strong> (Saturday). The digits refer to dates in each week and separated by a comma, such as <strong id="as_06_0409__b1355164616507">1,3,5</strong>.</li><li id="as_06_0409__li201465622210">If <strong id="as_06_0409__b84235270617528">recurrence_type</strong> is set to <strong id="as_06_0409__b18233185717501">Monthly</strong>, the value ranges from <strong id="as_06_0409__b724215572506">1</strong> to <strong id="as_06_0409__b1924215795014">31</strong>. The digits refer to the dates in each month and separated by a comma, such as <strong id="as_06_0409__b5242155735019">1,10,13,28</strong>.</li></ul>
</td>
</tr>
<tr id="as_06_0409__row11445615223"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_0409__p13141756172213">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_0409__p61485682213">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_0409__p215135612216">Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.</p>
<p id="as_06_0409__p1815185652218">The time format is <strong>YYYY-MM-DDThh:mmZ</strong>.</p>
</td>
</tr>
<tr id="as_06_0409__row15151056142213"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="as_06_0409__p1615556102211">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="as_06_0409__p215145642216">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="as_06_0409__p13151056112217">Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.</p>
<p id="as_06_0409__p71515622217">The time format is <strong>YYYY-MM-DDThh:mmZ</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="as_06_0409__table483105512229"></a><a name="table483105512229"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table483105512229" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="as_06_0409__b16838115717485">scaling_policy_action</strong> field description</caption><thead align="left"><tr id="as_06_0409__row1115556162215"><th align="left" class="cellrowborder" valign="top" width="26.26%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="as_06_0409__p915105622213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="as_06_0409__p515456122217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="as_06_0409__p415356112219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row162375692220"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="as_06_0409__p0231756162212">operation</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="as_06_0409__p22385652217">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="as_06_0409__p102355612220">Specifies the scaling action.</p>
<ul id="as_06_0409__ul193981245217"><li id="as_06_0409__li1239813241722"><strong id="as_06_0409__b167911758205010">ADD</strong>: indicates adding instances.</li><li id="as_06_0409__li113981924823"><strong id="as_06_0409__b84235270692351">REDUCE</strong>: indicates reducing instances.</li><li id="as_06_0409__li103985245217"><strong id="as_06_0409__b84235270692418">SET</strong>: indicates setting the number of instances to a specified value.</li></ul>
</td>
</tr>
<tr id="as_06_0409__row202355682217"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="as_06_0409__p2023175692218">size</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="as_06_0409__p12232564225">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="as_06_0409__p1123556122215">Specifies the operation size.</p>
</td>
</tr>
<tr id="as_06_0409__row15231656162219"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="as_06_0409__p1623205617226">percentage</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="as_06_0409__p923956192210">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="as_06_0409__p4233560223">Specifies the percentage of instances to be operated.</p>
</td>
</tr>
<tr id="as_06_0409__row92314569222"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="as_06_0409__p6231256202211">limits</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="as_06_0409__p1523195612216">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="as_06_0409__p524556122214">Specifies the operation restrictions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="as_06_0409__p2024677184"></p>
<div class="tablenoborder"><a name="as_06_0409__table14568680175854"></a><a name="table14568680175854"></a><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table14568680175854" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="as_06_0409__b121071212181110">meta_data</strong> field description</caption><thead align="left"><tr id="as_06_0409__row25036975175854"><th align="left" class="cellrowborder" valign="top" width="26.26%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="as_06_0409__p4598303175854">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="as_06_0409__p36918294175854">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="as_06_0409__p37591800175854">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row718192511356"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="as_06_0409__p9569123231519">metadata_bandwidth_share_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="as_06_0409__p15561153218251">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="as_06_0409__p13569103211151">Specifies the bandwidth sharing type in the bandwidth scaling policy.</p>
</td>
</tr>
<tr id="as_06_0409__row1551711309356"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="as_06_0409__p8569193210157">metadata_eip_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="as_06_0409__p7513133310255">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="as_06_0409__p15570173219155">Specifies the EIP ID for the bandwidth in the bandwidth scaling policy.</p>
</td>
</tr>
<tr id="as_06_0409__row41812515358"><td class="cellrowborder" valign="top" width="26.26%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="as_06_0409__p16570133219157">metadata_eip_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="as_06_0409__p206571934182515">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="as_06_0409__p145701132161516">Specifies the EIP for the bandwidth in the bandwidth scaling policy.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="as_06_0409__ul31398310175852"><li id="as_06_0409__li1693864732318">Example response<pre class="screen" id="as_06_0409__screen6972147192314">{
"scaling_policy": {
"scaling_policy_id": "906f73ff-56e8-41b2-a005-8157d0c60361",
"scaling_policy_name": "hth_aspolicy_1",
"scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
"scaling_resource_type": "BANDWIDTH",
"scaling_policy_type": "ALARM",
"alarm_id": "al1513822380493GvlJKZwA8",
"scheduled_policy": {
},
"cool_down_time": 900,
"scaling_policy_action": {
"operation": "ADD",
"size": 1,
"limits": 111
},
"policy_status": "INSERVICE",
"create_time": "2018-03-21T08:03:35Z",
"meta_data": {
"metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
"metadata_eip_address": "255.255.255.255"
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="as_06_0409__section15837125411231"><h4 class="sectiontitle">Returned Values</h4><ul id="as_06_0409__ul14521217122411"><li id="as_06_0409__li552115171242">Normal<p id="as_06_0409__p1552151702414"><a name="as_06_0409__li552115171242"></a><a name="li552115171242"></a>200</p>
</li><li id="as_06_0409__li105216172249">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0409__table744011712248" frame="border" border="1" rules="all"><thead align="left"><tr id="as_06_0409__row1352312178246"><th align="left" class="cellrowborder" valign="top" width="43.69%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="as_06_0409__p12523121792413">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.31%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="as_06_0409__p15523161782415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="as_06_0409__row19523417112410"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p1252361713241">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p5523101719246">The server failed to process the request.</p>
</td>
</tr>
<tr id="as_06_0409__row1552315172245"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p852311171245">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p052312177248">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="as_06_0409__row952311179244"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p1523141732417">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p18523817162419">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="as_06_0409__row5523111714248"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p352481762417">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p75248171241">The server could not find the requested page.</p>
</td>
</tr>
<tr id="as_06_0409__row7524417132417"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p25241517122412">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p652412175245">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="as_06_0409__row1524917152411"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p45241517132413">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p75241117112413">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="as_06_0409__row9524717152413"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p55241917172412">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p7524171710242">You must use the proxy server for authentication to process the request.</p>
</td>
</tr>
<tr id="as_06_0409__row1052401714244"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p35241817102415">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p752481772418">The request timed out.</p>
</td>
</tr>
<tr id="as_06_0409__row19524917112410"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p9524191742414">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p15241170241">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="as_06_0409__row1524121762417"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p1752421762411">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p2525191719246">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="as_06_0409__row115259174244"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p65251217122420">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p752571712419">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="as_06_0409__row17525217172418"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p145256172247">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p1752571752412">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="as_06_0409__row205258179249"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p752591715243">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p16525131711247">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="as_06_0409__row4525161716249"><td class="cellrowborder" valign="top" width="43.69%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="as_06_0409__p1652531714240">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.31%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="as_06_0409__p10525191702418">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="as_06_0409__section17669131616110"><h4 class="sectiontitle">Error Codes</h4><p id="as_06_0409__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_0400.html">AS Policies</a></div>
</div>
</div>