forked from docs/doc-exports
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>
297 lines
25 KiB
HTML
297 lines
25 KiB
HTML
<a name="as_06_0904"></a><a name="as_06_0904"></a>
|
|
|
|
<h1 class="topictitle1">Modifying a Lifecycle Hook</h1>
|
|
<div id="body1478134739515"><div class="section" id="as_06_0904__section2082935495536"><h4 class="sectiontitle">Function</h4><p id="as_06_0904__p290724799638">This interface is used to modify the information about a specified lifecycle hook.</p>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section1799627095536"><h4 class="sectiontitle">URI</h4><p id="as_06_0904__p2903857795536">PUT /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/{lifecycle_hook_name}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0904__table331451795536" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="as_06_0904__r5f2899b4cf1044948a7170d6333a7991"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.2.3.2.5.1.1"><p id="as_06_0904__abbee0f7ae9eb4969a9f3723d6c71359d"><strong id="as_06_0904__b11948137124216">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.2.5.1.2"><p id="as_06_0904__afee17afcb8d046f7bdf94bd2159fab28">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.5.1.3"><p id="as_06_0904__en-us_topic_0040779755_p706369995536">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_0904__a87b82e5148494b2eb7eaaf1f30bc54d9"><strong id="as_06_0904__b1492011385428">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0904__r7a944e3605614724ba8e74e5ad901592"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0904__en-us_topic_0040779755_p395071195536">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0904__a6fdb2099041d4c4ba1cc6a5958341e03">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0904__ae7bebc4d668c4593805a36a55c21d977">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0904__p36520930">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__r404f6ce83137490a866aefcaa49c2138"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0904__en-us_topic_0040779755_p745378510329">scaling_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0904__add10773cae7f42e48b093a8789a627e4">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0904__ace6f1d2e5e6f468299286df3bba7529b">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0904__a0e4dd57fff314be9a790db4310d6801e">Specifies the AS group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__r6294e43f10664f3e8f84b5b776cbd59b"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.2.3.2.5.1.1 "><p id="as_06_0904__a5b00453952f34ab8a2e34f33ad04f26c">lifecycle_hook_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.2 "><p id="as_06_0904__a0ae0e8d3926e432da15fccf7d4227c68">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.5.1.3 "><p id="as_06_0904__a9f40d66265a845139b0417aec15dd53e">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.3.2.5.1.4 "><p id="as_06_0904__a5ae6053e43ee4f0cade5c6e64a0a2f51">Specifies the lifecycle hook name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section2093926095536"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0904__table1617423919456" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="as_06_0904__rfd8444d0808147bcb3209de05c89ddf9"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.2.2.5.1.1"><p id="as_06_0904__en-us_topic_0040779753_p997525619456"><strong id="as_06_0904__b19993239114219">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.3.2.2.5.1.2"><p id="as_06_0904__en-us_topic_0040779753_p268942519456">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.2.2.5.1.3"><p id="as_06_0904__ac21481990d9a482c9a49051f5ee9b571">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47%" id="mcps1.3.3.2.2.5.1.4"><p id="as_06_0904__ad32b87a7a20d436b93a7608801fd9e6b"><strong id="as_06_0904__b98088406424">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0904__r57c8e9a6da5042b7a1162e42128025ca"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="as_06_0904__acfa7c2e1933d4410b65822ceb4bc32ab">lifecycle_hook_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.5.1.2 "><p id="as_06_0904__en-us_topic_0040779753_p204393319456">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.5.1.3 "><p id="as_06_0904__ab5e2a9daeb3e4f11aa22a7ef6c7c139a">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.2.2.5.1.4 "><p id="as_06_0904__p39693138194648">Specifies the lifecycle hook type. Options:</p>
|
|
<ul id="as_06_0904__ul15115141205417"><li id="as_06_0904__li1911517185416"><strong id="as_06_0904__b186051233115018">INSTANCE_TERMINATING</strong>: The hook suspends the instance when the instance is terminated.</li><li id="as_06_0904__li11151011540"><strong id="as_06_0904__b1810314695015">INSTANCE_LAUNCHING</strong>: The hook suspends the instance when the instance is started.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__ra36db1f439b14151aa1f00de8dde6b7f"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="as_06_0904__aa7af1b22abb74ee091c65d9bef3cdd79">default_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.5.1.2 "><p id="as_06_0904__aee2b9fc5db6e432ab84a49d75f1f0626">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.5.1.3 "><p id="as_06_0904__ab11d4d3345e4436b8f6e7de40712c0bd">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.2.2.5.1.4 "><p id="as_06_0904__ab085e3d0496c4dd38b5d2a939b1c723b">Specifies the default lifecycle hook callback operation. By default, this operation is performed when the timeout duration expires.</p>
|
|
<ul id="as_06_0904__ul1160665511537"><li id="as_06_0904__li7606355115319">ABANDON</li><li id="as_06_0904__li7606155515317">CONTINUE</li></ul>
|
|
<div class="note" id="as_06_0904__note11802827185419"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="as_06_0904__ul24181846125419"><li id="as_06_0904__li1941924615544">If an instance is starting, <strong id="as_06_0904__b84235270621244">CONTINUE</strong> indicates that your customized operations are successful and the instance can be used. <strong id="as_06_0904__b84235270621412">ABANDON</strong> indicates that your customized operations failed, and the instance will be terminated. In such a case, the scaling action fails, and you must create a new instance.</li><li id="as_06_0904__li1841913462549">If an instance is stopping, both <strong id="as_06_0904__b84235270621654">ABANDON</strong> and <strong id="as_06_0904__b8423527062178">CONTINUE</strong> allow instance termination. The difference between the two states is as follows: <strong id="as_06_0904__b806944977211019">ABANDON</strong> stops other lifecycle hooks, but <strong id="as_06_0904__b805901848211044">CONTINUE</strong> allows the completion of other lifecycle hooks.</li><li id="as_06_0904__li1441911465546">The default value of this parameter is <strong id="as_06_0904__b24130807221134">ABANDON</strong>.</li></ul>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__r21cea8eb080e4306a24dad7fbf138f32"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="as_06_0904__a7d5d5de5274341f581d16e19025fd2e5">default_timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.5.1.2 "><p id="as_06_0904__a5f7c2a2ad156434c922ec385cee1b29e">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.5.1.3 "><p id="as_06_0904__a61770e65a4dd4e5c9931098f41402abe">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.2.2.5.1.4 "><p id="as_06_0904__en-us_topic_0040779753_p10597269945">Specifies the lifecycle hook timeout duration, which ranges from 60 to 86400 in the unit of second. The default value is 3600.</p>
|
|
<p id="as_06_0904__afe03129a841a4e8eae59377ae0325271">By default, this parameter specifies the instance waiting duration. You can prolong the timeout duration or perform the <strong id="as_06_0904__b84235270621173">CONTINUE</strong> or <strong id="as_06_0904__b737135739211648">ABANDON</strong> operation before the timeout duration expires.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__r89abb49327414b169f497aabc8a8bbe0"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="as_06_0904__a627ecfb931a34f00a143cffbb6de59cb">notification_topic_urn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.5.1.2 "><p id="as_06_0904__a80fd51fd2eaf42ceb3bf5acdad1e0e07">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.5.1.3 "><p id="as_06_0904__aeb6873d45ebb495babe44294ea261e9d">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.2.2.5.1.4 "><p id="as_06_0904__a1a466ad3f20e47288b7635c5b890bc77">Specifies a unique topic in SMN.</p>
|
|
<p id="as_06_0904__a8f39102293d9456dbaa0ef29aa413367">This parameter specifies a notification object for a lifecycle hook. When an instance is suspended by the lifecycle hook, the SMN service sends a notification to the object. This notification contains the basic instance information, your customized notification content, and the token for controlling lifecycle operations.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__rf7a69c41e704426a825b07535f1e3941"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.2.2.5.1.1 "><p id="as_06_0904__a15e90932f2164275a8f5dd08609291e0">notification_metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.5.1.2 "><p id="as_06_0904__af5d62364d097489ab54e6e14d0af75c5">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.5.1.3 "><p id="as_06_0904__a43085cbab3964246885519c8ebd47586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.3.2.2.5.1.4 "><p id="as_06_0904__p54056399235">Specifies a customized notification, which contains no more than 256 characters in length. The message cannot contain the following characters: <>&'()</p>
|
|
<p id="as_06_0904__p3390971719358">After a notification object is configured, the SMN service sends your customized notification to the object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section18749923329"><h4 class="sectiontitle">Example Request</h4><div class="p" id="as_06_0904__p11539201533718">This example changes the callback operation of the lifecycle hook named <strong id="as_06_0904__b487495210502">test-hook1</strong> in the AS group with ID <strong id="as_06_0904__b10874145295011">e5d27f5c-dd76-4a61-b4bc-a67c5686719a</strong> to <strong id="as_06_0904__b03971025211">CONTINUE</strong>.<pre class="screen" id="as_06_0904__screen14795131216375">PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1
|
|
|
|
{
|
|
"default_result": "CONTINUE"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section5819104495536"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0904__table5077231195423" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="as_06_0904__row56377142052"><th align="left" class="cellrowborder" valign="top" width="28.139999999999997%" id="mcps1.3.5.2.2.4.1.1"><p id="as_06_0904__p4566587142052"><strong id="as_06_0904__b674094110425">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.979999999999999%" id="mcps1.3.5.2.2.4.1.2"><p id="as_06_0904__p34349290142052">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.879999999999995%" id="mcps1.3.5.2.2.4.1.3"><p id="as_06_0904__p36521659191614"><strong id="as_06_0904__b847914274213">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0904__row14129261142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p3619473142052">lifecycle_hook_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p24741890142052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p57936039142052">Specifies the lifecycle hook name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row51662304142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p23897135142052">lifecycle_hook_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p56619815142052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p22802287142052">Specifies the lifecycle hook type.</p>
|
|
<ul id="as_06_0904__ul1022974881510"><li id="as_06_0904__li1422984821510">INSTANCE_TERMINATING</li><li id="as_06_0904__li022916484152">INSTANCE_LAUNCHING</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row46977964142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p47118740142052">default_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p58521609142052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p42629874142052">Specifies the default lifecycle hook callback operation.</p>
|
|
<ul id="as_06_0904__ul115213518155"><li id="as_06_0904__li5521175141516">ABANDON</li><li id="as_06_0904__li1852118518157">CONTINUE</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row5774457142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p65077844142052">default_timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p36814016142052">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p29145316142052">Specifies the lifecycle hook timeout duration in the unit of second.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row60981259142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p40534967142052">notification_topic_urn</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p62106928142052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p64605277142052">Specifies a unique topic in SMN.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row44576587142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p53933794142052">notification_topic_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p6561185142052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p61694001142052">Specifies the topic name in SMN.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row18375103142052"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p11988363142052">notification_metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p31533307142052">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p4061047142052">Specifies the customized notification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row20187608142058"><td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.2.4.1.1 "><p id="as_06_0904__p24583540142058">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.979999999999999%" headers="mcps1.3.5.2.2.4.1.2 "><p id="as_06_0904__p45109684142058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.879999999999995%" headers="mcps1.3.5.2.2.4.1.3 "><p id="as_06_0904__p30005760142058">Specifies the time when the lifecycle hook is created. The time is UTC-compliant.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section1829412421929"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="as_06_0904__screen40081303191327">{
|
|
"lifecycle_hook_name": "test-hook1",
|
|
"default_result": "CONTINUE",
|
|
"default_timeout": 3600,
|
|
"notification_topic_urn": "urn:smn:<em id="as_06_0904__i65852948153042">regionId</em>:b53e5554fad0494d96206fb84296510b:gsh",
|
|
"notification_topic_name": "gsh",
|
|
"lifecycle_hook_type": "INSTANCE_LAUNCHING",
|
|
"notification_metadata": null,
|
|
"create_time": "2016-11-18T04:01:34Z"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section1489498995536"><h4 class="sectiontitle">Returned Values</h4><ul id="as_06_0904__ul6564343395536"><li id="as_06_0904__li5391999295536">Normal<p id="as_06_0904__p1551788295536"><a name="as_06_0904__li5391999295536"></a><a name="li5391999295536"></a>200</p>
|
|
</li><li id="as_06_0904__li544321895536">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="as_06_0904__table4898896895536" frame="border" border="1" rules="all"><thead align="left"><tr id="as_06_0904__row2202573295536"><th align="left" class="cellrowborder" valign="top" width="43.980000000000004%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="as_06_0904__p3925390595536">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.02%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="as_06_0904__p2544972695536">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="as_06_0904__row4816190795536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p880040995536">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p4174453595536">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row4015650395536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p3145134295536">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p6453073695536">You must enter the username and password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row4390571895536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p6670224695536">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p3417285595536">You are forbidden to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row3912024395536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p1462312895536">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p4362270595536">The server could not find the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row5706002995536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p5845961695536">405 Method Not Allowed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p3760842795536">You are not allowed to use the method specified in the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row293152795536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p3612717195536">406 Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p4061970695536">The response generated by the server could not be accepted by the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row3003304095536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p1675719895536">407 Proxy Authentication Required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p1515577295536">You must use the proxy server for authentication to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row218422095536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p4270415095536">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p3648411695536">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row5992159295536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p2181080895536">409 Conflict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p2184504195536">The request could not be processed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row6238764295536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p2023420295536">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p2835763895536">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row5389215795536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p318858395536">501 Not Implemented</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p5694869095536">Failed to complete the request because the server does not support the requested function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row4277616795536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p4231752695536">502 Bad Gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p516757795536">Failed to complete the request because the request is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row4650819895536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p906768395536">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p6339370495536">Failed to complete the request because the system is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="as_06_0904__row3367243095536"><td class="cellrowborder" valign="top" width="43.980000000000004%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="as_06_0904__p4311227595536">504 Gateway Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.02%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="as_06_0904__p243336495536">A gateway timeout error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="as_06_0904__section17669131616110"><h4 class="sectiontitle">Error Codes</h4><p id="as_06_0904__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_0900.html">Lifecycle Hooks</a></div>
|
|
</div>
|
|
</div>
|
|
|