forked from docs/doc-exports
Hasko, Vladimir
f3362c7fd1
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
372 lines
29 KiB
HTML
372 lines
29 KiB
HTML
<a name="ShowAsyncTaskResult"></a><a name="ShowAsyncTaskResult"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Result of an Asynchronous Task</h1>
|
|
<div id="body095714420225"><div class="section" id="ShowAsyncTaskResult__section209577402216"><h4 class="sectiontitle">Function</h4><p id="ShowAsyncTaskResult__p199577422214">This API is used to query the result of an asynchronous task.</p>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="ShowAsyncTaskResult__p19589462217">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="ShowAsyncTaskResult__p7959194172210">GET /v2/{project_id}/apigw/instances/{instance_id}/async-tasks/{task_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__table1796011418224" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row109591545227"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ShowAsyncTaskResult__p4961104132214">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ShowAsyncTaskResult__p16961194132210">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ShowAsyncTaskResult__p19615411228">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ShowAsyncTaskResult__p199624411225">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row2095915414223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ShowAsyncTaskResult__p196219472217">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ShowAsyncTaskResult__p896212492213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ShowAsyncTaskResult__p1296312472210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ShowAsyncTaskResult__p1796317417222">Project ID. For details about how to obtain it, see <a href="apig-api-180713009.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row2960448223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ShowAsyncTaskResult__p129641348229">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ShowAsyncTaskResult__p1696418472215">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ShowAsyncTaskResult__p11965648226">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ShowAsyncTaskResult__p20965134162216">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row796084182218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ShowAsyncTaskResult__p796518412217">task_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ShowAsyncTaskResult__p18966246229">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ShowAsyncTaskResult__p89661745229">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ShowAsyncTaskResult__p49661348228">Asynchronous task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__section10967194152212"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row2967142222"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ShowAsyncTaskResult__p1796911411222">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ShowAsyncTaskResult__p129693412217">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ShowAsyncTaskResult__p189695414221">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ShowAsyncTaskResult__p69701412216">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row12968184182216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ShowAsyncTaskResult__p4970442220">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ShowAsyncTaskResult__p997084172213">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ShowAsyncTaskResult__p397112420228">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ShowAsyncTaskResult__p69719414223">User token. 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 a token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__section197244102214"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowAsyncTaskResult__p119721141229"><strong id="ShowAsyncTaskResult__b497244162217">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__response_AsyncTaskResult" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row18973104122219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ShowAsyncTaskResult__p1497416422217">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ShowAsyncTaskResult__p14975241220">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ShowAsyncTaskResult__p169751545223">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row199731243222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowAsyncTaskResult__p16975114192219">task_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowAsyncTaskResult__p497624192211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowAsyncTaskResult__p1197674192219">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row119731544229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowAsyncTaskResult__p397616492210">task_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowAsyncTaskResult__p497724132215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowAsyncTaskResult__p11977840228">Task status. Options: waiting, processing, succeed, and failed.</p>
|
|
<p id="ShowAsyncTaskResult__p497714192217">Enumeration values:</p>
|
|
<ul id="ShowAsyncTaskResult__ul797817452213"><li id="ShowAsyncTaskResult__li1497874102217"><strong id="ShowAsyncTaskResult__b139785402219">waiting</strong></li><li id="ShowAsyncTaskResult__li497812492211"><strong id="ShowAsyncTaskResult__b89782418228">processing</strong></li><li id="ShowAsyncTaskResult__li14979154132210"><strong id="ShowAsyncTaskResult__b197910432218">succeed</strong></li><li id="ShowAsyncTaskResult__li1397913410227"><strong id="ShowAsyncTaskResult__b14979174112213">failed</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row197319442212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowAsyncTaskResult__p097917416229">task_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowAsyncTaskResult__p10980124172216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowAsyncTaskResult__p19801340222">Task type. Options: import_api and export_api. Both types of tasks are asynchronous.</p>
|
|
<p id="ShowAsyncTaskResult__p498054182210">Enumeration values:</p>
|
|
<ul id="ShowAsyncTaskResult__ul098114419220"><li id="ShowAsyncTaskResult__li149811744226"><strong id="ShowAsyncTaskResult__b898111432211">import_api</strong></li><li id="ShowAsyncTaskResult__li19814472210"><strong id="ShowAsyncTaskResult__b398174192211">export_api</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row13973345222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowAsyncTaskResult__p1398218412211">task_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowAsyncTaskResult__p13982644225">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowAsyncTaskResult__p79823462211">Task result. A string can be converted into a JSON object. If task_type is set to import_api, the fields include group_id, success (array), failure (array), swagger (structure), and ignore (array). The success array contains four fields: id (ID of a successfully imported API), method (API request method), path (API request path), and action (update or create). The failure array also contains four fields: method (API request method), path (API request path), error_code (import error code), and error_msg (import error message). The swagger structure contains two fields: id (Swagger file ID) and result (import result). The ignore array has two elements: method (API request method) and path (API request path). If task_type is set to export_api, the fields include file_type and content.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowAsyncTaskResult__p1198354172216"><strong id="ShowAsyncTaskResult__b3983174132216">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row498317414224"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ShowAsyncTaskResult__p1498415432210">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ShowAsyncTaskResult__p7985545223">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ShowAsyncTaskResult__p1198510482212">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row99834415229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ShowAsyncTaskResult__p1298634192210">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ShowAsyncTaskResult__p109861443220">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ShowAsyncTaskResult__p798644172213">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row1698317452219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ShowAsyncTaskResult__p14987194112218">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ShowAsyncTaskResult__p698794162217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ShowAsyncTaskResult__p119885414222">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowAsyncTaskResult__p39889414223"><strong id="ShowAsyncTaskResult__b99883442215">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row19889415220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="ShowAsyncTaskResult__p1799154182214">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="ShowAsyncTaskResult__p17991124132210">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="ShowAsyncTaskResult__p18991194112217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row1998913414226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ShowAsyncTaskResult__p29928412225">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ShowAsyncTaskResult__p149921242223">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ShowAsyncTaskResult__p899314142219">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row1598914102219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ShowAsyncTaskResult__p2993144142218">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ShowAsyncTaskResult__p499310482210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ShowAsyncTaskResult__p159942402219">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowAsyncTaskResult__p1499416442210"><strong id="ShowAsyncTaskResult__b10994144152220">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row899516492216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="ShowAsyncTaskResult__p0996114142218">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="ShowAsyncTaskResult__p799611482214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="ShowAsyncTaskResult__p29973417225">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row099516442211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ShowAsyncTaskResult__p19978418220">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ShowAsyncTaskResult__p1799713413226">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ShowAsyncTaskResult__p109981842222">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row299518419225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ShowAsyncTaskResult__p159981941223">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ShowAsyncTaskResult__p499817422214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ShowAsyncTaskResult__p1599915417224">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowAsyncTaskResult__p79993442213"><strong id="ShowAsyncTaskResult__b1899917412211">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row1999915422213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="ShowAsyncTaskResult__p140159225">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="ShowAsyncTaskResult__p14117542212">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="ShowAsyncTaskResult__p1811959220">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row1399913416220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ShowAsyncTaskResult__p91185102217">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ShowAsyncTaskResult__p92135102212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ShowAsyncTaskResult__p133185182216">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row899915411222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ShowAsyncTaskResult__p741654221">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ShowAsyncTaskResult__p1417512212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ShowAsyncTaskResult__p047592211">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowAsyncTaskResult__p1741554224"><strong id="ShowAsyncTaskResult__b1953513223">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowAsyncTaskResult__row1754511222"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="ShowAsyncTaskResult__p5616542212">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="ShowAsyncTaskResult__p18714502220">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="ShowAsyncTaskResult__p20735192218">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row1520502219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="ShowAsyncTaskResult__p188519224">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="ShowAsyncTaskResult__p11820562216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="ShowAsyncTaskResult__p1797517227">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row85195182213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="ShowAsyncTaskResult__p1395513226">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="ShowAsyncTaskResult__p121014515229">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="ShowAsyncTaskResult__p2101756220">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__section7113513226"><h4 class="sectiontitle">Example Requests</h4><p id="ShowAsyncTaskResult__p6111514229">None</p>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__section7129582213"><h4 class="sectiontitle">Example Responses</h4><p id="ShowAsyncTaskResult__p1613552224"><strong id="ShowAsyncTaskResult__b181312512221">Status code: 200</strong></p>
|
|
<p id="ShowAsyncTaskResult__p111335162216">OK</p>
|
|
<ul id="ShowAsyncTaskResult__ul1013558221"><li id="ShowAsyncTaskResult__li9131556227">Example 1<pre class="screen" id="ShowAsyncTaskResult__screen101415502212">{
|
|
"task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2",
|
|
"task_status" : "succeed",
|
|
"task_type" : "import_api",
|
|
"task_result" : "{\"success\":[{\"id\":\"ee93ce6815f04896b301452982b92222\",\"action\":\"create\",\"method\":\"GET\",\"path\":\"/test1\"}],\"failure\":[],\"swagger\":{\"id\":\"de1852ab6c5e4090b0bd88a02058e650\",\"result\":\"Success\"},\"group_id\":\"9100ae30705947cc9543d37cd7fb388c\"}"
|
|
}</pre>
|
|
</li><li id="ShowAsyncTaskResult__li141612572217">Example 2<pre class="screen" id="ShowAsyncTaskResult__screen2164522219">{
|
|
"task_id" : "d6e8834b6f0f4711a2fa5345e5b60833",
|
|
"task_status" : "succeed",
|
|
"task_type" : "export_api",
|
|
"task_result" : "{\"FileName\":\"test8-RELEASE-all-2023-07-11-19:54:22\",\"FileType\":\".json\",\"Comment\":\"{\\n\\t\\\"swagger\\\": \\\"2.0\\\",\\n\\t\\\"info\\\": {\\n\\t\\t\\\"title\\\": \\\"test8\\\",\\n\\t\\t\\\"version\\\": \\\"2023-07-11-19:54:22\\\"\\n\\t},\\n\\t\\\"host\\\": \\\"xxx.com\\\",\\n\\t\\\"paths\\\": {\\n\\t\\t\\\"/test1\\\": {\\n\\t\\t\\t\\\"get\\\": {\\n\\t\\t\\t\\t\\\"security\\\": [\\n\\t\\t\\t\\t\\t{\\n\\t\\t\\t\\t\\t\\t\\\"apig-auth-app\\\": []\\n\\t\\t\\t\\t\\t}\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"schemes\\\": [\\n\\t\\t\\t\\t\\t\\\"https\\\"\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"operationId\\\": \\\"API_zjev\\\",\\n\\t\\t\\t\\t\\\"responses\\\": {\\n\\t\\t\\t\\t\\t\\\"default\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"$ref\\\": \\\"#/responses/default\\\"\\n\\t\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\t\\\"x-apigateway-result-failure-sample\\\": \\\"\\\",\\n\\t\\t\\t\\t\\t\\\"x-apigateway-result-normal-sample\\\": \\\"\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"x-apigateway-backend\\\": {\\n\\t\\t\\t\\t\\t\\\"mockEndpoints\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"description\\\": \\\"\\\",\\n\\t\\t\\t\\t\\t\\t\\\"result-content\\\": \\\"not ok\\\"\\n\\t\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\t\\\"type\\\": \\\"MOCK\\\"\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"x-apigateway-cors\\\": false,\\n\\t\\t\\t\\t\\\"x-apigateway-match-mode\\\": \\\"NORMAL\\\",\\n\\t\\t\\t\\t\\\"x-apigateway-request-type\\\": \\\"public\\\"\\n\\t\\t\\t}\\n\\t\\t}\\n\\t},\\n\\t\\\"responses\\\": {\\n\\t\\t\\\"default\\\": {\\n\\t\\t\\t\\\"description\\\": \\\"response example\\\"\\n\\t\\t}\\n\\t},\\n\\t\\\"securityDefinitions\\\": {\\n\\t\\t\\\"apig-auth-app\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Authorization\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"AppSigv1\\\"\\n\\t\\t},\\n\\t\\t\\\"apig-auth-app-header\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Authorization\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-opt\\\": {\\n\\t\\t\\t\\t\\\"appcode-auth-type\\\": \\\"header\\\"\\n\\t\\t\\t},\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"AppSigv1\\\"\\n\\t\\t},\\n\\t\\t\\\"apig-auth-iam\\\": {\\n\\t\\t\\t\\\"type\\\": \\\"apiKey\\\",\\n\\t\\t\\t\\\"name\\\": \\\"unused\\\",\\n\\t\\t\\t\\\"in\\\": \\\"header\\\",\\n\\t\\t\\t\\\"x-apigateway-auth-type\\\": \\\"IAM\\\"\\n\\t\\t}\\n\\t}\\n,\\n\\t\\\"x-apigateway-responses\\\": {}\\n}\"}"
|
|
}</pre>
|
|
</li><li id="ShowAsyncTaskResult__li61817542214">Example 3<pre class="screen" id="ShowAsyncTaskResult__screen5199562218">{
|
|
"task_id" : "f01d2772ea4944408fa544c8ae5a9999",
|
|
"task_status" : "failed",
|
|
"task_type" : "import_api",
|
|
"task_result" : "{\"error_code\":\"APIG.3201\",\"error_msg\":\"The API group name already exists\"}"
|
|
}</pre>
|
|
</li><li id="ShowAsyncTaskResult__li420155112218">Example 4<pre class="screen" id="ShowAsyncTaskResult__screen12113519227">{
|
|
"task_id" : "4dfbf6acaacf4c41a8b3c50daa90d3dc",
|
|
"task_status" : "processing",
|
|
"task_type" : "import_api",
|
|
"task_result" : ""
|
|
}</pre>
|
|
</li><li id="ShowAsyncTaskResult__li8224582220">Example 5<pre class="screen" id="ShowAsyncTaskResult__screen2023115122215">{
|
|
"task_id" : "c3b78a52fb28461aab92bf6c6989f731",
|
|
"task_status" : "waiting",
|
|
"task_type" : "import_api",
|
|
"task_result" : ""
|
|
}</pre>
|
|
</li></ul>
|
|
<p id="ShowAsyncTaskResult__p32485172217"><strong id="ShowAsyncTaskResult__b5241512218">Status code: 400</strong></p>
|
|
<p id="ShowAsyncTaskResult__p6241353229">Bad Request</p>
|
|
<pre class="screen" id="ShowAsyncTaskResult__screen152515515228">{
|
|
"error_code" : "APIG.2001",
|
|
"error_msg" : "The request parameters must be specified,parameterName:task_id. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="ShowAsyncTaskResult__p725354221"><strong id="ShowAsyncTaskResult__b92614592217">Status code: 401</strong></p>
|
|
<p id="ShowAsyncTaskResult__p13261351224">Unauthorized</p>
|
|
<pre class="screen" id="ShowAsyncTaskResult__screen172615122212">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="ShowAsyncTaskResult__p102710510226"><strong id="ShowAsyncTaskResult__b17271259226">Status code: 403</strong></p>
|
|
<p id="ShowAsyncTaskResult__p172720582218">Forbidden</p>
|
|
<pre class="screen" id="ShowAsyncTaskResult__screen142813518225">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="ShowAsyncTaskResult__p10281351223"><strong id="ShowAsyncTaskResult__b172919522211">Status code: 404</strong></p>
|
|
<p id="ShowAsyncTaskResult__p122912518224">Not Found</p>
|
|
<pre class="screen" id="ShowAsyncTaskResult__screen7291354229">{
|
|
"error_code" : "APIG.3093",
|
|
"error_msg" : "The asynchronous task d9ce8c9eede54b3f841ec324fe0bfdc2 does not exist"
|
|
}</pre>
|
|
<p id="ShowAsyncTaskResult__p33016512222"><strong id="ShowAsyncTaskResult__b12301859224">Status code: 500</strong></p>
|
|
<p id="ShowAsyncTaskResult__p183012516229">Internal Server Error</p>
|
|
<pre class="screen" id="ShowAsyncTaskResult__screen93113582218">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__section131195142210"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowAsyncTaskResult__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowAsyncTaskResult__row16321657223"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ShowAsyncTaskResult__p16336572219">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ShowAsyncTaskResult__p433751226">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowAsyncTaskResult__row19321532211"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowAsyncTaskResult__p63413511222">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowAsyncTaskResult__p1351513225">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row93225172214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowAsyncTaskResult__p37381759226">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowAsyncTaskResult__p147389562219">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row203215502213"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowAsyncTaskResult__p17391059225">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowAsyncTaskResult__p14739145112213">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row932655221"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowAsyncTaskResult__p973915513224">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowAsyncTaskResult__p117394592219">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row532155102215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowAsyncTaskResult__p173914552217">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowAsyncTaskResult__p1673915562219">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowAsyncTaskResult__row1733185152218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowAsyncTaskResult__p20739145152217">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowAsyncTaskResult__p12739125102212">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowAsyncTaskResult__section773913532214"><h4 class="sectiontitle">Error Codes</h4><p id="ShowAsyncTaskResult__p47401252222">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="AsynchronousTaskManagement.html">Asynchronous Task Management</a></div>
|
|
</div>
|
|
</div>
|
|
|