vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/apig/api-ref/ExportApiDefinitionsAsync.html
Chen, Junjie 2fc8a34abd APIG API 20240125 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-10-25 11:19:06 +00:00

378 lines
29 KiB
HTML
Raw Blame History

<a name="ExportApiDefinitionsAsync"></a><a name="ExportApiDefinitionsAsync"></a>
<h1 class="topictitle1">Exporting APIs Asynchronously</h1>
<div id="body20425151141813"><div class="section" id="ExportApiDefinitionsAsync__section2426915189"><h4 class="sectiontitle">Function</h4><p id="ExportApiDefinitionsAsync__p1642651141815">This API is used to export APIs in a specified API group. The content of the exported file complies with the Swagger standard. For details about the custom extended fields of APIG, see section "Extended Definition" in the User Guide.</p>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section1442791141818"><h4 class="sectiontitle">Calling Method</h4><p id="ExportApiDefinitionsAsync__p1942710101819">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section5428181161811"><h4 class="sectiontitle">URI</h4><p id="ExportApiDefinitionsAsync__p18429819186">POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/async-export</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__table5431101171813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row124302151811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ExportApiDefinitionsAsync__p143118101813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ExportApiDefinitionsAsync__p2043219191813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ExportApiDefinitionsAsync__p743310151811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ExportApiDefinitionsAsync__p343317117182">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row2430111131810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p1743414131813">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p54343112189">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p20435121161816">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p114362017183">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="ExportApiDefinitionsAsync__row114303116186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p1243710114183">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p10438121151811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p1643917113186">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p1843971191816">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__table1144211121816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row644119131811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ExportApiDefinitionsAsync__p44428111189">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ExportApiDefinitionsAsync__p644331181812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ExportApiDefinitionsAsync__p3444101161817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ExportApiDefinitionsAsync__p184448161818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row34416121817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p744510118184">oas_version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p1644691101815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p194468110182">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p184476151814">OpenAPI version.</p>
<p id="ExportApiDefinitionsAsync__p1244711117182">Default: <strong id="ExportApiDefinitionsAsync__b444818181810">2.0</strong></p>
<p id="ExportApiDefinitionsAsync__p1844881141819">Enumeration values:</p>
<ul id="ExportApiDefinitionsAsync__ul9449141111816"><li id="ExportApiDefinitionsAsync__li17449121101818"><strong id="ExportApiDefinitionsAsync__b444914171810">2.0</strong></li><li id="ExportApiDefinitionsAsync__li545011141820"><strong id="ExportApiDefinitionsAsync__b13450616189">3.0</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section445131121812"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row1745213118182"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ExportApiDefinitionsAsync__p6453141121812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ExportApiDefinitionsAsync__p745416171810">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ExportApiDefinitionsAsync__p19455116188">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ExportApiDefinitionsAsync__p17455112183">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row11452115189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p7456191121816">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p1345711111813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p15457810181">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p94587116183">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__request_ExportOpenApiReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row345915171819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="ExportApiDefinitionsAsync__p12461141111814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="ExportApiDefinitionsAsync__p1246141201817">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="ExportApiDefinitionsAsync__p1462311181">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="ExportApiDefinitionsAsync__p174629141812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row11459613186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p124631414189">env_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p1146419115185">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p104640161819">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p8465161181812">ID of the environment in which APIs of a group have been published.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row184591113181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p9465191191814">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p16466161181811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p84662161813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p84671119189">API group ID.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row184591911185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p174688118183">define</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p174681910183">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p154697113180">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p1946913112184">Definition scope of the APIs to be exported:</p>
<ul id="ExportApiDefinitionsAsync__ul4470161101815"><li id="ExportApiDefinitionsAsync__li54704110183">spec: basic definitions, including only the frontend definitions.</li><li id="ExportApiDefinitionsAsync__li54719113182">proxy: full definitions, including the frontend and backend definitions.</li><li id="ExportApiDefinitionsAsync__li547110116182">all: extended definitions, including the frontend and backend definitions as well as request throttling policies, access control policies, and custom authorizers.</li><li id="ExportApiDefinitionsAsync__li1147213111182">dev: development definitions, including the frontend and backend definitions of APIs that have not been published.</li></ul>
<p id="ExportApiDefinitionsAsync__p1147314110181">Default: <strong id="ExportApiDefinitionsAsync__b547321191816">spec</strong></p>
<p id="ExportApiDefinitionsAsync__p14734116181">Enumeration values:</p>
<ul id="ExportApiDefinitionsAsync__ul1547451141820"><li id="ExportApiDefinitionsAsync__li847418113183"><strong id="ExportApiDefinitionsAsync__b9474219187">spec</strong></li><li id="ExportApiDefinitionsAsync__li114744115187"><strong id="ExportApiDefinitionsAsync__b1247581101811">proxy</strong></li><li id="ExportApiDefinitionsAsync__li1447511121811"><strong id="ExportApiDefinitionsAsync__b3475514185">all</strong></li><li id="ExportApiDefinitionsAsync__li3476131201817"><strong id="ExportApiDefinitionsAsync__b0476612184">dev</strong></li></ul>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row3459161161810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p44762181820">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p1347701111818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p174781119182">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p1247821181818">Format for exporting API definitions.</p>
<p id="ExportApiDefinitionsAsync__p74790121813">Default: <strong id="ExportApiDefinitionsAsync__b24794111819">json</strong></p>
<p id="ExportApiDefinitionsAsync__p174792141817">Enumeration values:</p>
<ul id="ExportApiDefinitionsAsync__ul848012110183"><li id="ExportApiDefinitionsAsync__li54801114188"><strong id="ExportApiDefinitionsAsync__b1248012111813">json</strong></li><li id="ExportApiDefinitionsAsync__li948014141811"><strong id="ExportApiDefinitionsAsync__b048113121816">yaml</strong></li><li id="ExportApiDefinitionsAsync__li18481201191813"><strong id="ExportApiDefinitionsAsync__b13481716183">yml</strong></li></ul>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row1645914115187"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p04826113189">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p2483201151815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p1048321131810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p748461121815">Version number of the APIs after exporting. The default value is the current date and time.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row84595171811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsAsync__p144841114185">apis</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsAsync__p848519110189">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsAsync__p14486131161815">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsAsync__p1548671181819">IDs of the APIs to be exported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section74871618189"><h4 class="sectiontitle">Response Parameters</h4><p id="ExportApiDefinitionsAsync__p154881117184"><strong id="ExportApiDefinitionsAsync__b204880114187">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__response_AsyncTaskInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row1488161121815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ExportApiDefinitionsAsync__p1549018121811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ExportApiDefinitionsAsync__p17490413180">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ExportApiDefinitionsAsync__p449118141816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row114886119186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p2491131141810">task_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p349281161812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p1749218151812">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ExportApiDefinitionsAsync__p154936131814"><strong id="ExportApiDefinitionsAsync__b149316115188">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row5494161161820"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ExportApiDefinitionsAsync__p6495416182">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ExportApiDefinitionsAsync__p149619111180">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ExportApiDefinitionsAsync__p134969110180">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row17494151181817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p194977171812">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p134979117189">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p24981016187">Error code.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row1549410115180"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p549812111182">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p1549918131819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p10500610189">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ExportApiDefinitionsAsync__p650010119186"><strong id="ExportApiDefinitionsAsync__b1250091131819">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__table1950017110186" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row450111151819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="ExportApiDefinitionsAsync__p45021516187">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="ExportApiDefinitionsAsync__p15503311189">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="ExportApiDefinitionsAsync__p75035181816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row185011819183"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p250415121815">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p1350417181817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p125055141818">Error code.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row175017111816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p1050531131818">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p55061911188">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p1350719161815">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ExportApiDefinitionsAsync__p650781121814"><strong id="ExportApiDefinitionsAsync__b165074115188">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__table8508812183" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row1050811181814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="ExportApiDefinitionsAsync__p8509151121811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="ExportApiDefinitionsAsync__p1051061111815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="ExportApiDefinitionsAsync__p1951014181815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row125081019181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p8511151161815">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p651111141813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p1351212161810">Error code.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row4508121141811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p1151281151813">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p10513619188">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p05141318182">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ExportApiDefinitionsAsync__p10514111161815"><strong id="ExportApiDefinitionsAsync__b11514917188">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__table55151115182" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsAsync__row8515811188"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="ExportApiDefinitionsAsync__p45161510183">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="ExportApiDefinitionsAsync__p185171810182">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="ExportApiDefinitionsAsync__p1251715117185">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row251515113181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p1651851171812">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p95181316187">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p19519515187">Error code.</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row195154161817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ExportApiDefinitionsAsync__p1852010111811">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ExportApiDefinitionsAsync__p145207141810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ExportApiDefinitionsAsync__p105212113186">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section16521116182"><h4 class="sectiontitle">Example Requests</h4><p id="ExportApiDefinitionsAsync__p8522111171816">Exporting APIs in batches</p>
<pre class="screen" id="ExportApiDefinitionsAsync__screen4523171141811">{
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"define" : "all"
}</pre>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section9526618187"><h4 class="sectiontitle">Example Responses</h4><p id="ExportApiDefinitionsAsync__p115270151817"><strong id="ExportApiDefinitionsAsync__b17527410187">Status code: 202</strong></p>
<p id="ExportApiDefinitionsAsync__p3527151101810">Accepted</p>
<pre class="screen" id="ExportApiDefinitionsAsync__screen75281718181">{
"task_id" : "d9ce8c9eede54b3f841ec324fe0bfdc2"
}</pre>
<p id="ExportApiDefinitionsAsync__p65299131814"><strong id="ExportApiDefinitionsAsync__b17530131121815">Status code: 400</strong></p>
<p id="ExportApiDefinitionsAsync__p13530318181">Bad Request</p>
<pre class="screen" id="ExportApiDefinitionsAsync__screen15531131101814">{
"error_code" : "APIG.2001",
"error_msg" : "The request parameters must be specified,parameterName:env_id. Please refer to the support documentation"
}</pre>
<p id="ExportApiDefinitionsAsync__p115337118187"><strong id="ExportApiDefinitionsAsync__b6533141181811">Status code: 401</strong></p>
<p id="ExportApiDefinitionsAsync__p3534171191810">Unauthorized</p>
<pre class="screen" id="ExportApiDefinitionsAsync__screen9535111131813">{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}</pre>
<p id="ExportApiDefinitionsAsync__p14537118189"><strong id="ExportApiDefinitionsAsync__b45381813183">Status code: 403</strong></p>
<p id="ExportApiDefinitionsAsync__p8538171191817">Forbidden</p>
<pre class="screen" id="ExportApiDefinitionsAsync__screen553910114183">{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}</pre>
<p id="ExportApiDefinitionsAsync__p1754141161814"><strong id="ExportApiDefinitionsAsync__b25411610184">Status code: 500</strong></p>
<p id="ExportApiDefinitionsAsync__p175411911184">Internal Server Error</p>
<pre class="screen" id="ExportApiDefinitionsAsync__screen254215181816">{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}</pre>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section11544171161818"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsAsync__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ExportApiDefinitionsAsync__row1854511191814"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ExportApiDefinitionsAsync__p1655721111813">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ExportApiDefinitionsAsync__p195581121817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExportApiDefinitionsAsync__row135557111819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsAsync__p145595111811">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsAsync__p105601118182">Accepted</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row55561191811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsAsync__p1556091141815">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsAsync__p8561517185">Bad Request</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row655610111818"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsAsync__p2056115110187">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsAsync__p6562101131814">Unauthorized</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row955614161813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsAsync__p145620115184">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsAsync__p6563617186">Forbidden</p>
</td>
</tr>
<tr id="ExportApiDefinitionsAsync__row9556116182"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsAsync__p256414113184">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsAsync__p20674121186">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExportApiDefinitionsAsync__section1167432131820"><h4 class="sectiontitle">Error Codes</h4><p id="ExportApiDefinitionsAsync__p19675152111816">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>
View Git Blame Copy Permalink