forked from docs/doc-exports
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
435 lines
34 KiB
HTML
435 lines
34 KiB
HTML
<a name="functiongraph_06_0142"></a><a name="functiongraph_06_0142"></a>
|
||
|
||
<h1 class="topictitle1">Configuring Asynchronous Execution Notification</h1>
|
||
<div id="body1202049744"><div class="section" id="functiongraph_06_0142__section8204913410"><h4 class="sectiontitle">Function</h4><p id="functiongraph_06_0142__p4818490412">This API is used to configure asynchronous execution notification for a function.</p>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section203094912410"><h4 class="sectiontitle">URI</h4><p id="functiongraph_06_0142__p1038114917412">PUT /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-config</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__table205254919411" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="functiongraph_06_0142__row144512492414"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="functiongraph_06_0142__p115415491548">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="functiongraph_06_0142__p86011497419">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="functiongraph_06_0142__p567134916416">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="functiongraph_06_0142__p9776495412">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row134544911411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="functiongraph_06_0142__p88318496411">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="functiongraph_06_0142__p88915495420">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="functiongraph_06_0142__p179614913411">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="functiongraph_06_0142__p410516495411">Project ID. For details, see <a href="functiongraph_06_0260.html">Obtaining a Project ID</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row134554912413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="functiongraph_06_0142__p19112194910416">function_urn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="functiongraph_06_0142__p211815491945">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="functiongraph_06_0142__p1112517491543">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="functiongraph_06_0142__p18131049749">Function URN. For details, see the function model description.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section814112491141"><h4 class="sectiontitle">Request Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="functiongraph_06_0142__row2014711491746"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="functiongraph_06_0142__p161587491642">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="functiongraph_06_0142__p10164549242">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="functiongraph_06_0142__p161732491646">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="functiongraph_06_0142__p5179104918417">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row51471549244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="functiongraph_06_0142__p9186649143">X-Auth-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="functiongraph_06_0142__p1019319497417">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="functiongraph_06_0142__p820016491544">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="functiongraph_06_0142__p920734910411">User token.</p>
|
||
<p id="functiongraph_06_0142__p42123494416">It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row514815491844"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="functiongraph_06_0142__p5219204917418">Content-Type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="functiongraph_06_0142__p32254491048">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="functiongraph_06_0142__p122349491649">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="functiongraph_06_0142__p22399499417">Message body type (format).</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__request_UpdateFunctionAsyncInvokeConfigRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="functiongraph_06_0142__row142441549948"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="functiongraph_06_0142__p1025410492413">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="functiongraph_06_0142__p15259174913416">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="functiongraph_06_0142__p152667499414">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="functiongraph_06_0142__p12271114919410">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row024417491941"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="functiongraph_06_0142__p32771049542">max_async_event_age_in_seconds</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="functiongraph_06_0142__p18284849547">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="functiongraph_06_0142__p1528914491543">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="functiongraph_06_0142__p2297549144">Maximum validity period of a message. Value range: 1s to 86,400s. Default value: 3600s.</p>
|
||
<p id="functiongraph_06_0142__p13303194914411">Minimum: <strong id="functiongraph_06_0142__b1830614913416">1</strong></p>
|
||
<p id="functiongraph_06_0142__p2031014495415">Maximum: <strong id="functiongraph_06_0142__b10313449847">86400</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row17244124914420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="functiongraph_06_0142__p1831684912415">max_async_retry_attempts</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="functiongraph_06_0142__p932110499416">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="functiongraph_06_0142__p15328849245">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="functiongraph_06_0142__p133345497415">Maximum number of retry attempts to be made if asynchronous invocation fails. Default value: 1. Value range: 0–3.</p>
|
||
<p id="functiongraph_06_0142__p73409491742">Minimum: <strong id="functiongraph_06_0142__b1534319493416">0</strong></p>
|
||
<p id="functiongraph_06_0142__p1634718491419">Maximum: <strong id="functiongraph_06_0142__b33501498414">3</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row2244154915414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="functiongraph_06_0142__p2035420497413">destination_config</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="functiongraph_06_0142__p8361349541">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="functiongraph_06_0142__p33681449145"><a href="#functiongraph_06_0142__request_FuncAsyncDestinationConfig">FuncAsyncDestinationConfig</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="functiongraph_06_0142__p1377124912418">Asynchronous invocation target.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row19244164911410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="functiongraph_06_0142__p63825496417">enable_async_status_log</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="functiongraph_06_0142__p12389349045">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="functiongraph_06_0142__p839514916419">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="functiongraph_06_0142__p194017494415">Whether to enable asynchronous invocation status persistence.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="functiongraph_06_0142__request_FuncAsyncDestinationConfig"></a><a name="request_FuncAsyncDestinationConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__request_FuncAsyncDestinationConfig" frame="border" border="1" rules="all"><caption><b>Table 4 </b>FuncAsyncDestinationConfig</caption><thead align="left"><tr id="functiongraph_06_0142__row84071849345"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="functiongraph_06_0142__p1241718497411">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="functiongraph_06_0142__p342434912411">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="functiongraph_06_0142__p742911491446">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="functiongraph_06_0142__p1743524913417">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row240811493416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="functiongraph_06_0142__p114425490413">on_success</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="functiongraph_06_0142__p6449849141">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="functiongraph_06_0142__p1645716498413"><a href="#functiongraph_06_0142__request_FuncDestinationConfig">FuncDestinationConfig</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="functiongraph_06_0142__p146210491342">Target to be invoked when a function is successfully executed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row940810497418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="functiongraph_06_0142__p1846918491349">on_failure</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="functiongraph_06_0142__p184740492414">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="functiongraph_06_0142__p448218496411"><a href="#functiongraph_06_0142__request_FuncDestinationConfig">FuncDestinationConfig</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="functiongraph_06_0142__p184888491645">Target to be invoked when a function fails to be executed due to a system error or an internal error.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="functiongraph_06_0142__request_FuncDestinationConfig"></a><a name="request_FuncDestinationConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__request_FuncDestinationConfig" frame="border" border="1" rules="all"><caption><b>Table 5 </b>FuncDestinationConfig</caption><thead align="left"><tr id="functiongraph_06_0142__row134961949141"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="functiongraph_06_0142__p1505164912419">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="functiongraph_06_0142__p1251010491649">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="functiongraph_06_0142__p1551744912411">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="functiongraph_06_0142__p1552214917415">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row1949614913417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="functiongraph_06_0142__p11527349542">destination</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="functiongraph_06_0142__p5534549344">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="functiongraph_06_0142__p5541749145">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="functiongraph_06_0142__p45498491142">Object type.</p>
|
||
<ul id="functiongraph_06_0142__ul125561449740"><li id="functiongraph_06_0142__li855794917414">OBS</li><li id="functiongraph_06_0142__li1756519491414">SMN</li><li id="functiongraph_06_0142__li857919491841">FunctionGraph</li></ul>
|
||
<p id="functiongraph_06_0142__p125853498415">Enumeration values:</p>
|
||
<ul id="functiongraph_06_0142__ul759318491645"><li id="functiongraph_06_0142__li25941149844"><strong id="functiongraph_06_0142__b359894911418">OBS</strong></li><li id="functiongraph_06_0142__li76003498410"><strong id="functiongraph_06_0142__b760410496418">SMN</strong></li><li id="functiongraph_06_0142__li1561316497412"><strong id="functiongraph_06_0142__b1961744912420">FunctionGraph</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row549612498410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="functiongraph_06_0142__p86208491416">param</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="functiongraph_06_0142__p562711491846">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="functiongraph_06_0142__p5633649242">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="functiongraph_06_0142__p7641849543">Parameters (in JSON format) corresponding to the target service.</p>
|
||
<ul id="functiongraph_06_0142__ul12647154917418"><li id="functiongraph_06_0142__li464811491845">OBS: Parameters related to the bucket name, object directory prefix, and object expiration time are included. The object expiration time ranges from 0 to 365 days. If the value is 0, the object will not expire.</li><li id="functiongraph_06_0142__li1565613491846">SMN: The topic_urn parameter is included.</li><li id="functiongraph_06_0142__li1167011491643">FunctionGraph: The func_urn parameter is included.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section126803494416"><h4 class="sectiontitle">Response Parameters</h4><p id="functiongraph_06_0142__p06862490417"><strong id="functiongraph_06_0142__b13690114917419">Status code: 200</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__response_UpdateFunctionAsyncInvokeConfigResponseBody" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="functiongraph_06_0142__row2069215493412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="functiongraph_06_0142__p87036496410">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="functiongraph_06_0142__p1470911491414">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="functiongraph_06_0142__p17156491643">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row186929491242"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p17201749248">func_urn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p5726134913417">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p073414919415">Function URN.</p>
|
||
<p id="functiongraph_06_0142__p6739124914410">Minimum: <strong id="functiongraph_06_0142__b167423493413">1</strong></p>
|
||
<p id="functiongraph_06_0142__p374410498419">Maximum: <strong id="functiongraph_06_0142__b13747154915417">269</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row76921491147"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p1275112491342">max_async_event_age_in_seconds</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p157566496414">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p7762124918412">Maximum validity period of a message. Value range: 60–86,400. Unit: second.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row146922491414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p157688498411">max_async_retry_attempts</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p37741549241">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p978084912419">Maximum number of retry attempts to be made if asynchronous invocation fails. Default value: 3. Value range: 0–8.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row176933491419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p1178674914420">destination_config</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p979210493410"><a href="#functiongraph_06_0142__response_FuncAsyncDestinationConfig">FuncAsyncDestinationConfig</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p178001449144">Asynchronous invocation target.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row10693349247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p138291949140">created_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p108370492411">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p78441493411">Time when asynchronous execution notification was configured.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row196933491148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p98509495413">last_modified</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p28659498410">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p8875949449">Time when the asynchronous execution notification settings were last modified.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row1169310491441"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="functiongraph_06_0142__p988311493414">enable_async_status_log</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="functiongraph_06_0142__p108941449244">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="functiongraph_06_0142__p1690054912416">Whether to enable asynchronous invocation status persistence.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="functiongraph_06_0142__response_FuncAsyncDestinationConfig"></a><a name="response_FuncAsyncDestinationConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__response_FuncAsyncDestinationConfig" frame="border" border="1" rules="all"><caption><b>Table 7 </b>FuncAsyncDestinationConfig</caption><thead align="left"><tr id="functiongraph_06_0142__row79067491242"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="functiongraph_06_0142__p991711496413">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="functiongraph_06_0142__p119244491541">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="functiongraph_06_0142__p1093034913410">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row090744910413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="functiongraph_06_0142__p893920494415">on_success</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="functiongraph_06_0142__p09471849945"><a href="#functiongraph_06_0142__response_FuncDestinationConfig">FuncDestinationConfig</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="functiongraph_06_0142__p395494916415">Target to be invoked when a function is successfully executed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row14907134919410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="functiongraph_06_0142__p17961049247">on_failure</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="functiongraph_06_0142__p29721249141"><a href="#functiongraph_06_0142__response_FuncDestinationConfig">FuncDestinationConfig</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="functiongraph_06_0142__p89782493419">Target to be invoked when a function fails to be executed due to a system error or an internal error.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="functiongraph_06_0142__response_FuncDestinationConfig"></a><a name="response_FuncDestinationConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__response_FuncDestinationConfig" frame="border" border="1" rules="all"><caption><b>Table 8 </b>FuncDestinationConfig</caption><thead align="left"><tr id="functiongraph_06_0142__row7987049142"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="functiongraph_06_0142__p12015011411">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="functiongraph_06_0142__p16795013410">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="functiongraph_06_0142__p6149502410">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row159876497412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="functiongraph_06_0142__p182019502044">destination</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="functiongraph_06_0142__p22511501543">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="functiongraph_06_0142__p1933145015410">Object type.</p>
|
||
<ul id="functiongraph_06_0142__ul1742550349"><li id="functiongraph_06_0142__li343105015414">OBS</li><li id="functiongraph_06_0142__li35117509414">SMN</li><li id="functiongraph_06_0142__li25895018415">FunctionGraph</li></ul>
|
||
<p id="functiongraph_06_0142__p974650744">Enumeration values:</p>
|
||
<ul id="functiongraph_06_0142__ul19821150343"><li id="functiongraph_06_0142__li10848504419"><strong id="functiongraph_06_0142__b990650945">OBS</strong></li><li id="functiongraph_06_0142__li18932501748"><strong id="functiongraph_06_0142__b161149501647">SMN</strong></li><li id="functiongraph_06_0142__li121432050949"><strong id="functiongraph_06_0142__b2202550648">FunctionGraph</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row0988349249"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="functiongraph_06_0142__p1020610508417">param</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="functiongraph_06_0142__p223425017415">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="functiongraph_06_0142__p1424114507418">Parameters (in JSON format) corresponding to the target service.</p>
|
||
<ul id="functiongraph_06_0142__ul725111501148"><li id="functiongraph_06_0142__li152524501741">OBS: Parameters related to the bucket name, object directory prefix, and object expiration time are included. The object expiration time ranges from 0 to 365 days. If the value is 0, the object will not expire.</li><li id="functiongraph_06_0142__li0258175011413">SMN: The topic_urn parameter is included.</li><li id="functiongraph_06_0142__li827912501418">FunctionGraph: The func_urn parameter is included.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="functiongraph_06_0142__p828655010411"><strong id="functiongraph_06_0142__b02894501541">Status code: 400</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="functiongraph_06_0142__row62931350746"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="functiongraph_06_0142__p173041550346">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="functiongraph_06_0142__p133132508411">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="functiongraph_06_0142__p113201150542">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row11293115018419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="functiongraph_06_0142__p232945016410">error_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="functiongraph_06_0142__p33622501247">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="functiongraph_06_0142__p23671350046">Error code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row1029318501342"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="functiongraph_06_0142__p23755501048">error_msg</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="functiongraph_06_0142__p83811350047">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="functiongraph_06_0142__p83891505414">Error message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="functiongraph_06_0142__p103941250848"><strong id="functiongraph_06_0142__b23979501243">Status code: 404</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__table2039925015414" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="functiongraph_06_0142__row113993502041"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="functiongraph_06_0142__p5412205014415">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="functiongraph_06_0142__p114261850549">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="functiongraph_06_0142__p643795010415">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row1439917508416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="functiongraph_06_0142__p3443115010411">error_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="functiongraph_06_0142__p174562501647">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="functiongraph_06_0142__p1246115019412">Error code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row1400135017420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="functiongraph_06_0142__p11469050246">error_msg</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="functiongraph_06_0142__p124742050141">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="functiongraph_06_0142__p9483550740">Error message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section7489165017419"><h4 class="sectiontitle">Example Requests</h4><p id="functiongraph_06_0142__p16499150742">Configure asynchronous execution notification for a function with max. validity period of 10s and max. retries of 3, and enable asynchronous invocation status persistence.</p>
|
||
<pre class="screen" id="functiongraph_06_0142__screen351035013418">PUT /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-config
|
||
|
||
{
|
||
"max_async_event_age_in_seconds" : 10,
|
||
"max_async_retry_attempts" : 3,
|
||
"enable_async_status_log" : true
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section1275255611412"><h4 class="sectiontitle">Example Responses</h4><p id="functiongraph_06_0142__p475819561843"><strong id="functiongraph_06_0142__b11759756640">Status code: 200</strong></p>
|
||
<p id="functiongraph_06_0142__p117616561413">Ok</p>
|
||
<pre class="screen" id="functiongraph_06_0142__screen27655567411">{
|
||
"func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194xxxxxxxxxx:function:default:test:latest",
|
||
"max_async_event_age_in_seconds" : 60,
|
||
"max_async_retry_attempts" : 1,
|
||
"destination_config" : {
|
||
"on_success" : {
|
||
"destination" : "FunctionGraph",
|
||
"param" : "{\"func_urn\":\"urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}"
|
||
},
|
||
"on_failure" : {
|
||
"destination" : "FunctionGraph",
|
||
"param" : "{\"func_urn\":\"urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}"
|
||
}
|
||
},
|
||
"created_time" : "2021-03-04T14:50:02+08:00",
|
||
"last_modified" : "2021-03-04 14:50:02"
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section168161756742"><h4 class="sectiontitle">Status Codes</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="functiongraph_06_0142__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="functiongraph_06_0142__row363210507416"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="functiongraph_06_0142__p382118566416">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="functiongraph_06_0142__p68242561244">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="functiongraph_06_0142__row13632750142"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="functiongraph_06_0142__p12827256040">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="functiongraph_06_0142__p1482985617414">Ok</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row166339501342"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="functiongraph_06_0142__p1983210568410">400</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="functiongraph_06_0142__p1783465616413">Bad Request</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="functiongraph_06_0142__row15633195016415"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="functiongraph_06_0142__p783710561143">404</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="functiongraph_06_0142__p1184212567418">Not Found</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="functiongraph_06_0142__section584675615415"><h4 class="sectiontitle">Error Codes</h4><p id="functiongraph_06_0142__p985085610410">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="AsynchronousExecutionNotification.html">Asynchronous Execution Notification</a></div>
|
||
</div>
|
||
</div>
|
||
|