forked from docs/doc-exports
411 lines
31 KiB
HTML
411 lines
31 KiB
HTML
<a name="ExportApiDefinitionsV2"></a><a name="ExportApiDefinitionsV2"></a>
|
|
|
|
<h1 class="topictitle1">Exporting APIs</h1>
|
|
<div id="body3421182421710"><div class="section" id="ExportApiDefinitionsV2__section10422524141716"><h4 class="sectiontitle">Function</h4><p id="ExportApiDefinitionsV2__p842262461714">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="ExportApiDefinitionsV2__section164221924161716"><h4 class="sectiontitle">Calling Method</h4><p id="ExportApiDefinitionsV2__p442252411715">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section14422162419179"><h4 class="sectiontitle">URI</h4><p id="ExportApiDefinitionsV2__p164235243173">POST /v2/{project_id}/apigw/instances/{instance_id}/openapi/export</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__table4424122491720" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row84237246179"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ExportApiDefinitionsV2__p9425132441712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ExportApiDefinitionsV2__p14251824141711">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ExportApiDefinitionsV2__p1142615246174">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ExportApiDefinitionsV2__p1642632416174">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row10424132412175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p342662419177">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p154261624141716">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p242682410172">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p84271247174">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="ExportApiDefinitionsV2__row15424192441717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p6427724111720">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p204271324191718">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p12427122412175">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p104283246175">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="ExportApiDefinitionsV2__table5429192451712" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row134281824111716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ExportApiDefinitionsV2__p1142942401716">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ExportApiDefinitionsV2__p8429132461713">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ExportApiDefinitionsV2__p542942412172">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ExportApiDefinitionsV2__p174290246175">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row14428924141712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ExportApiDefinitionsV2__p043042410173">oas_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ExportApiDefinitionsV2__p104301624141714">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ExportApiDefinitionsV2__p1543018248173">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ExportApiDefinitionsV2__p143018244172">Open API version.</p>
|
|
<p id="ExportApiDefinitionsV2__p134301244172">Default: <strong id="ExportApiDefinitionsV2__b34304243176">2.0</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p184314249177">Enumeration values:</p>
|
|
<ul id="ExportApiDefinitionsV2__ul19431524101717"><li id="ExportApiDefinitionsV2__li443122461717"><strong id="ExportApiDefinitionsV2__b9431324171718">2.0</strong></li><li id="ExportApiDefinitionsV2__li4431152481719"><strong id="ExportApiDefinitionsV2__b443112481711">3.0</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section04317242173"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row14432102491710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ExportApiDefinitionsV2__p2432192418174">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ExportApiDefinitionsV2__p743316247178">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ExportApiDefinitionsV2__p14433172411713">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ExportApiDefinitionsV2__p14331224141713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row5432424181716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ExportApiDefinitionsV2__p17433152413179">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ExportApiDefinitionsV2__p14434132412171">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ExportApiDefinitionsV2__p13434624181712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ExportApiDefinitionsV2__p17434182414179">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="ExportApiDefinitionsV2__request_ExportOpenApiReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Request body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row34351024131718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="ExportApiDefinitionsV2__p94361624201713">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="ExportApiDefinitionsV2__p1943632416179">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="ExportApiDefinitionsV2__p194362024111715">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="ExportApiDefinitionsV2__p1843702421713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row643513245172"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p1043752451720">env_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p843710247177">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p7437424151710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p17438122415170">ID of the environment in which APIs of a group have been published.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row44358242170"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p13438152471710">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p15439112451712">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p104391024131712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p643952416176">API group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row1543532415173"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p1943972415178">define</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p19439102419176">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p14439152418173">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p194401324141718">Definition scope of the APIs to be exported:</p>
|
|
<ul id="ExportApiDefinitionsV2__ul12440152416176"><li id="ExportApiDefinitionsV2__li64401024171713">spec: basic definitions, including only the frontend definitions.</li><li id="ExportApiDefinitionsV2__li174400243175">proxy: full definitions, including the frontend and backend definitions.</li><li id="ExportApiDefinitionsV2__li2044013241175">all: extended definitions, including the frontend and backend definitions as well as request throttling policies, access control policies, and custom authorizers.</li><li id="ExportApiDefinitionsV2__li344062481718">dev: development definitions, including the frontend and backend definitions of APIs that have not been published.</li></ul>
|
|
<p id="ExportApiDefinitionsV2__p2441724151720">Default: <strong id="ExportApiDefinitionsV2__b114411624161716">spec</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p1244172471717">Enumeration values:</p>
|
|
<ul id="ExportApiDefinitionsV2__ul144411324131713"><li id="ExportApiDefinitionsV2__li64411724131716"><strong id="ExportApiDefinitionsV2__b844115248178">spec</strong></li><li id="ExportApiDefinitionsV2__li154411824201711"><strong id="ExportApiDefinitionsV2__b944115245174">proxy</strong></li><li id="ExportApiDefinitionsV2__li1944162401719"><strong id="ExportApiDefinitionsV2__b174411724181717">all</strong></li><li id="ExportApiDefinitionsV2__li104411924141717"><strong id="ExportApiDefinitionsV2__b1144262419177">dev</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row04351624181719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p184421424121719">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p64421324191711">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p84421724191720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p2442112411176">Format for exporting API definitions.</p>
|
|
<p id="ExportApiDefinitionsV2__p94421242171">Default: <strong id="ExportApiDefinitionsV2__b10443202491710">json</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p444382419171">Enumeration values:</p>
|
|
<ul id="ExportApiDefinitionsV2__ul1944382411715"><li id="ExportApiDefinitionsV2__li84436245178"><strong id="ExportApiDefinitionsV2__b1744316244175">json</strong></li><li id="ExportApiDefinitionsV2__li154431824151718"><strong id="ExportApiDefinitionsV2__b1244372418175">yaml</strong></li><li id="ExportApiDefinitionsV2__li4443142416177"><strong id="ExportApiDefinitionsV2__b544314243175">yml</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row17435102481716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p4443192411173">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p14444324141714">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p644482410174">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p1544472481710">Version number of the APIs after exporting. The default value is the current date and time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row10435924191717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="ExportApiDefinitionsV2__p184446249178">apis</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="ExportApiDefinitionsV2__p9444162441719">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="ExportApiDefinitionsV2__p20445142411714">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="ExportApiDefinitionsV2__p1044532416171">IDs of the APIs to be exported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section11445524201711"><h4 class="sectiontitle">Response Parameters</h4><p id="ExportApiDefinitionsV2__p1844592413179"><strong id="ExportApiDefinitionsV2__b16445424151711">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__response_-" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row11448924161711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ExportApiDefinitionsV2__p844872411174">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ExportApiDefinitionsV2__p5449724181712">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ExportApiDefinitionsV2__p84495247170">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row54483247176"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ExportApiDefinitionsV2__p74492244171">-</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ExportApiDefinitionsV2__p1344942419171">File</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ExportApiDefinitionsV2__p944911247171">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ExportApiDefinitionsV2__p5450122420177"><strong id="ExportApiDefinitionsV2__b24505241172">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row104501324101718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ExportApiDefinitionsV2__p44519243175">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ExportApiDefinitionsV2__p3451924121716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ExportApiDefinitionsV2__p124511124111718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row134501424191711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ExportApiDefinitionsV2__p7451224181713">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ExportApiDefinitionsV2__p11451112411719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ExportApiDefinitionsV2__p445242420174">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row12450202411717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ExportApiDefinitionsV2__p94521924121718">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ExportApiDefinitionsV2__p645212248175">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ExportApiDefinitionsV2__p184528240171">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ExportApiDefinitionsV2__p74521724131712"><strong id="ExportApiDefinitionsV2__b24522243174">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__table54531724181718" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row1145317244178"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="ExportApiDefinitionsV2__p6454924131713">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="ExportApiDefinitionsV2__p1145472481712">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="ExportApiDefinitionsV2__p245462421711">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row144533244177"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ExportApiDefinitionsV2__p2045422481715">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ExportApiDefinitionsV2__p245415248173">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ExportApiDefinitionsV2__p10455182451712">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row204532243175"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ExportApiDefinitionsV2__p04559247177">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ExportApiDefinitionsV2__p94551724101720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ExportApiDefinitionsV2__p1455824191716">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ExportApiDefinitionsV2__p114550243174"><strong id="ExportApiDefinitionsV2__b14455142461716">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__table145512412178" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row15456112431716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="ExportApiDefinitionsV2__p164571824111712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="ExportApiDefinitionsV2__p2045792441714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="ExportApiDefinitionsV2__p124581224141711">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row19456224151710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ExportApiDefinitionsV2__p845818247176">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ExportApiDefinitionsV2__p204581524171718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ExportApiDefinitionsV2__p1045842461711">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row1045617247171"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ExportApiDefinitionsV2__p1458122421712">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ExportApiDefinitionsV2__p845915247174">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ExportApiDefinitionsV2__p9459202471718">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ExportApiDefinitionsV2__p5459112412178"><strong id="ExportApiDefinitionsV2__b84591224181720">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__table12459172411177" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row14591924141710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="ExportApiDefinitionsV2__p146042416179">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="ExportApiDefinitionsV2__p144612242177">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="ExportApiDefinitionsV2__p246182471710">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row5460142401717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ExportApiDefinitionsV2__p194611424161711">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ExportApiDefinitionsV2__p1546211245172">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ExportApiDefinitionsV2__p046215248172">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row346022417178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ExportApiDefinitionsV2__p34621324101713">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ExportApiDefinitionsV2__p446212244174">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ExportApiDefinitionsV2__p24631124131711">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ExportApiDefinitionsV2__p144637247176"><strong id="ExportApiDefinitionsV2__b046312243172">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__table144633241173" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="ExportApiDefinitionsV2__row114631247174"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="ExportApiDefinitionsV2__p144646242179">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="ExportApiDefinitionsV2__p7464124141710">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="ExportApiDefinitionsV2__p1546522411171">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row6463102481710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="ExportApiDefinitionsV2__p64655240174">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="ExportApiDefinitionsV2__p15465172401714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="ExportApiDefinitionsV2__p246513249172">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row1346332441716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="ExportApiDefinitionsV2__p64651246178">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="ExportApiDefinitionsV2__p174661624131715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="ExportApiDefinitionsV2__p2466024181716">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section446682421719"><h4 class="sectiontitle">Example Requests</h4><p id="ExportApiDefinitionsV2__p154662241176">Exporting APIs</p>
|
|
<pre class="screen" id="ExportApiDefinitionsV2__screen74679241177">{
|
|
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
|
|
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
|
|
"define" : "all"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section1546711245173"><h4 class="sectiontitle">Example Responses</h4><p id="ExportApiDefinitionsV2__p446817244179"><strong id="ExportApiDefinitionsV2__b1468424101718">Status code: 400</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p646802431719">Bad Request</p>
|
|
<pre class="screen" id="ExportApiDefinitionsV2__screen24681624151714">{
|
|
"error_code" : "APIG.2001",
|
|
"error_msg" : "The request parameters must be specified,parameterName:env_id. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="ExportApiDefinitionsV2__p11468122413174"><strong id="ExportApiDefinitionsV2__b16469924121712">Status code: 401</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p11469122451713">Unauthorized</p>
|
|
<pre class="screen" id="ExportApiDefinitionsV2__screen184691824151710">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="ExportApiDefinitionsV2__p204698249176"><strong id="ExportApiDefinitionsV2__b204694242172">Status code: 403</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p5470162416173">Forbidden</p>
|
|
<pre class="screen" id="ExportApiDefinitionsV2__screen247015243172">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="ExportApiDefinitionsV2__p1247017249171"><strong id="ExportApiDefinitionsV2__b104701424101712">Status code: 404</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p1447062431714">Not Found</p>
|
|
<pre class="screen" id="ExportApiDefinitionsV2__screen74711924171713">{
|
|
"error_code" : "APIG.3001",
|
|
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
|
|
}</pre>
|
|
<p id="ExportApiDefinitionsV2__p1247132418171"><strong id="ExportApiDefinitionsV2__b134711724191714">Status code: 500</strong></p>
|
|
<p id="ExportApiDefinitionsV2__p9471132471711">Internal Server Error</p>
|
|
<pre class="screen" id="ExportApiDefinitionsV2__screen14472152401710">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section44721524121717"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExportApiDefinitionsV2__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ExportApiDefinitionsV2__row184731924131719"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ExportApiDefinitionsV2__p12502172571710">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ExportApiDefinitionsV2__p13502112561712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ExportApiDefinitionsV2__row2473172491718"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsV2__p8502192512174">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsV2__p1550292541710">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row134731924171718"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsV2__p1550214251179">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsV2__p1450232591717">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row4474132411174"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsV2__p1450252581713">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsV2__p050252511174">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row154743246179"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsV2__p250219259172">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsV2__p2502132520179">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row147411245171"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsV2__p1750262515173">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsV2__p750232517178">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ExportApiDefinitionsV2__row124748241176"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ExportApiDefinitionsV2__p950218252179">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ExportApiDefinitionsV2__p19502325171713">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ExportApiDefinitionsV2__section155026259172"><h4 class="sectiontitle">Error Codes</h4><p id="ExportApiDefinitionsV2__p1850216254177">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ApiImportExport.html">API Import and Export</a></div>
|
|
</div>
|
|
</div>
|
|
|