vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/apig/api-ref/CreateGatewayResponseV2_1.html
vladimirvshivkov cab615fbec Revert "APIG API 20240125 version" 
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: vladimirvshivkov <vshivkovvladimir@gmail.com>
Co-committed-by: vladimirvshivkov <vshivkovvladimir@gmail.com>
2024-11-05 10:39:48 +00:00

531 lines
39 KiB
HTML
Raw Blame History

<a name="CreateGatewayResponseV2_1"></a><a name="CreateGatewayResponseV2_1"></a>
<h1 class="topictitle1">Creating a Group Response</h1>
<div id="body855111044810"><div class="section" id="CreateGatewayResponseV2_1__section16551410154817"><h4 class="sectiontitle">Function</h4><p id="CreateGatewayResponseV2_1__p8551151018486">This API is used to create a response for an API group.</p>
</div>
<div class="section" id="CreateGatewayResponseV2_1__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="CreateGatewayResponseV2_1__p855201013484">POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__table155541010154813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row1155391004811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateGatewayResponseV2_1__p1855411074818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateGatewayResponseV2_1__p5554010194818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateGatewayResponseV2_1__p855411103489">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateGatewayResponseV2_1__p555521017482">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row5553101074811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p105551610144819">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p355521016487">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p955501084813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p205561410144812">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="CreateGatewayResponseV2_1__row17553191014815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p105562107489">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p2055621004819">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p6556201019484">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p15557161012483">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row8553141014814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p1455711109487">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p6557181054816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p16557910174813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p1255781010483">API group ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateGatewayResponseV2_1__section19558141034812"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row18558510104812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateGatewayResponseV2_1__p18559141084819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateGatewayResponseV2_1__p1955912106487">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateGatewayResponseV2_1__p1856011107480">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateGatewayResponseV2_1__p856041084817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row1255871014480"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p856071074811">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p156081074817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p1656101044817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p1856191017482">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="CreateGatewayResponseV2_1__request_ResponsesCreate" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row165621810134816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateGatewayResponseV2_1__p4563510184815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateGatewayResponseV2_1__p656318109484">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateGatewayResponseV2_1__p135631710164810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateGatewayResponseV2_1__p18563510144811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row85621910124810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p11564201012489">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p1056411054811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p0564181013487">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p185642010124819">Response name.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row056271012486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p1256581014486">responses</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p1356514105488">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p185651710134820">Map&lt;String,<a href="#CreateGatewayResponseV2_1__request_ResponseInfo">ResponseInfo</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p16566151064815">Response type definition. key indicates the error type. Options of key:</p>
<ul id="CreateGatewayResponseV2_1__ul1656651010485"><li id="CreateGatewayResponseV2_1__li1056610107484">AUTH_FAILURE: Authentication failed.</li><li id="CreateGatewayResponseV2_1__li1956612109482">AUTH_HEADER_MISSING: The identity source is missing.</li><li id="CreateGatewayResponseV2_1__li7566151016485">AUTHORIZER_FAILURE: Custom authentication failed.</li><li id="CreateGatewayResponseV2_1__li1856671017481">AUTHORIZER_CONF_FAILURE: Custom authorizer error.</li><li id="CreateGatewayResponseV2_1__li956761044813">AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.</li><li id="CreateGatewayResponseV2_1__li13569210154815">BACKEND_UNAVAILABLE: The backend is unavailable.</li><li id="CreateGatewayResponseV2_1__li1356913102487">BACKEND_TIMEOUT: Backend timed out.</li><li id="CreateGatewayResponseV2_1__li1056991019480">THROTTLED: The request was rejected due to request throttling.</li><li id="CreateGatewayResponseV2_1__li145691210204815">UNAUTHORIZED: The app you are using has not been authorized to call the API.</li><li id="CreateGatewayResponseV2_1__li1257015101486">ACCESS_DENIED: Access denied.</li><li id="CreateGatewayResponseV2_1__li457011014486">NOT_FOUND: No API is found.</li><li id="CreateGatewayResponseV2_1__li7570121064812">REQUEST_PARAMETERS_FAILURE: Invalid request parameter.</li><li id="CreateGatewayResponseV2_1__li2057018109488">DEFAULT_4XX: Default 4XX error occurred.</li><li id="CreateGatewayResponseV2_1__li195701910164811">DEFAULT_5XX: Default 5XX error occurred.</li></ul>
<p id="CreateGatewayResponseV2_1__p3571121018483">Each error type is in JSON format.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateGatewayResponseV2_1__request_ResponseInfo"></a><a name="request_ResponseInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__request_ResponseInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseInfo</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row357231016483"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateGatewayResponseV2_1__p115731610104819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateGatewayResponseV2_1__p0573141054818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateGatewayResponseV2_1__p25731610164816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateGatewayResponseV2_1__p1457316109484">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row35723106481"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p0574510164815">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p1557418103484">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p257416109486">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p857401004811">HTTP status code of the response.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row957211094819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateGatewayResponseV2_1__p20575101054817">body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateGatewayResponseV2_1__p157511014488">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateGatewayResponseV2_1__p19575201011483">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateGatewayResponseV2_1__p14575151014817">Response body template.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateGatewayResponseV2_1__section55761010174811"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateGatewayResponseV2_1__p5576101016481"><strong id="CreateGatewayResponseV2_1__b957611094810">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ResponsesInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row257611014488"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateGatewayResponseV2_1__p1557871013481">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateGatewayResponseV2_1__p1257813102486">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateGatewayResponseV2_1__p125781610154818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row75771310194818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p2578010104811">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p757951034819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p657981020481">Response name.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row18577410194816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p557917104486">responses</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p45791510124811">Map&lt;String,<a href="#CreateGatewayResponseV2_1__response_ResponseInfoResp">ResponseInfoResp</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p358013109488">Response type definition. key indicates the error type. Options of key:</p>
<ul id="CreateGatewayResponseV2_1__ul165801010104813"><li id="CreateGatewayResponseV2_1__li12580191094810">AUTH_FAILURE: Authentication failed.</li><li id="CreateGatewayResponseV2_1__li1658051014489">AUTH_HEADER_MISSING: The identity source is missing.</li><li id="CreateGatewayResponseV2_1__li258031018485">AUTHORIZER_FAILURE: Custom authentication failed.</li><li id="CreateGatewayResponseV2_1__li758019105487">AUTHORIZER_CONF_FAILURE: Custom authorizer error.</li><li id="CreateGatewayResponseV2_1__li05811310134818">AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.</li><li id="CreateGatewayResponseV2_1__li35811110204814">BACKEND_UNAVAILABLE: The backend is unavailable.</li><li id="CreateGatewayResponseV2_1__li258121014484">BACKEND_TIMEOUT: Backend timed out.</li><li id="CreateGatewayResponseV2_1__li458114108483">THROTTLED: The request was rejected due to request throttling.</li><li id="CreateGatewayResponseV2_1__li16581131054819">UNAUTHORIZED: The app you are using has not been authorized to call the API.</li><li id="CreateGatewayResponseV2_1__li158281084815">ACCESS_DENIED: Access denied.</li><li id="CreateGatewayResponseV2_1__li658251014488">NOT_FOUND: No API is found.</li><li id="CreateGatewayResponseV2_1__li16582510184819">REQUEST_PARAMETERS_FAILURE: Invalid request parameter.</li><li id="CreateGatewayResponseV2_1__li19582910114818">DEFAULT_4XX: Default 4XX error occurred.</li><li id="CreateGatewayResponseV2_1__li1158220101481">DEFAULT_5XX: Default 5XX error occurred.</li></ul>
<p id="CreateGatewayResponseV2_1__p155831110104811">Each error type is in JSON format.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row1957791019487"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p20583810114811">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p558441018488">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p125841910174817">Response ID.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row115776105483"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p7584131014819">default</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p18584141018484">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p18585141074818">Indicates whether the group response is the default response.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row2577710124812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p2058531084814">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p145851110154815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p558616105485">Creation time.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row11577810164812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p18586510154815">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p125862101487">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p25865104487">Update time.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateGatewayResponseV2_1__response_ResponseInfoResp"></a><a name="response_ResponseInfoResp"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ResponseInfoResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ResponseInfoResp</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row1258731011483"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateGatewayResponseV2_1__p11588610104812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="CreateGatewayResponseV2_1__p6589110124817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="CreateGatewayResponseV2_1__p558981044819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row1758751017480"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p15589151044815">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p175906104489">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p1659001014816">HTTP status code of the response.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row13587111016484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p4590151014482">body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p1591161074814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p10591191084819">Response body template.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row158721018483"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p559141014810">default</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p15927104481">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p1592181034813">Indicates whether the response is the default response.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateGatewayResponseV2_1__p459231014813"><strong id="CreateGatewayResponseV2_1__b1159318105486">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row15593710114812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="CreateGatewayResponseV2_1__p17594181084812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="CreateGatewayResponseV2_1__p5595191074814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="CreateGatewayResponseV2_1__p5595181011482">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row205931010184818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p11595151014480">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p85961510134815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p1459601010489">Error code.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row115931810194811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p155963103481">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p8597910154817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p115977101481">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateGatewayResponseV2_1__p10597171014817"><strong id="CreateGatewayResponseV2_1__b7597101074812">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row8598141024810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="CreateGatewayResponseV2_1__p6599131019482">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="CreateGatewayResponseV2_1__p14599110174816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="CreateGatewayResponseV2_1__p1859981018487">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row1559813105485"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p5599111016481">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p1160011019481">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p66001310184814">Error code.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row1459813109484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p66001107485">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p6600191074814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p1060081013488">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateGatewayResponseV2_1__p1601131010484"><strong id="CreateGatewayResponseV2_1__b860181084813">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row1601201064811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="CreateGatewayResponseV2_1__p6604810174817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="CreateGatewayResponseV2_1__p2604110174815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="CreateGatewayResponseV2_1__p1760513105482">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row186012103488"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p19605101011487">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p166059107489">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p260541014811">Error code.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row1160111101486"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p186061310134810">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p1660613106480">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p06069109482">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateGatewayResponseV2_1__p060631094814"><strong id="CreateGatewayResponseV2_1__b14606710154812">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row1060701016484"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="CreateGatewayResponseV2_1__p960741014486">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="CreateGatewayResponseV2_1__p9608151034811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="CreateGatewayResponseV2_1__p4608141017486">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row19607210154811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p126081610144813">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p116088101487">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p186088109480">Error code.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row260761014810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p860914105487">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p66091910124816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p1060981064810">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateGatewayResponseV2_1__p260916102487"><strong id="CreateGatewayResponseV2_1__b1960991014482">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2_1__row206107101487"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="CreateGatewayResponseV2_1__p0611141094810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.2"><p id="CreateGatewayResponseV2_1__p1361113102488">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.14.2.4.1.3"><p id="CreateGatewayResponseV2_1__p66114106481">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row20610151004817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p1161141017487">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p1161241044813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p14612111064815">Error code.</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row561081014810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateGatewayResponseV2_1__p17612181015486">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateGatewayResponseV2_1__p196129103489">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateGatewayResponseV2_1__p161241016486">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateGatewayResponseV2_1__section1061311014482"><h4 class="sectiontitle">Example Requests</h4><p id="CreateGatewayResponseV2_1__p10361101117483">Creating a response for an API group</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen17361131119481">{
"name" : "response_demo"
}</pre>
</div>
<div class="section" id="CreateGatewayResponseV2_1__section63611211154813"><h4 class="sectiontitle">Example Responses</h4><p id="CreateGatewayResponseV2_1__p113618119485"><strong id="CreateGatewayResponseV2_1__b9361161119483">Status code: 201</strong></p>
<p id="CreateGatewayResponseV2_1__p036101114812">Created</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen1036115115482">{
"create_time" : "2020-08-12T14:52:02.829753306+08:00",
"update_time" : "2020-08-12T14:52:02.829753306+08:00",
"default" : false,
"id" : "e839b367e10f4ab19d1c5008e476b83a",
"name" : "response_demo",
"responses" : {
"ACCESS_DENIED" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 403
},
"AUTHORIZER_CONF_FAILURE" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 500
},
"AUTHORIZER_FAILURE" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 500
},
"AUTHORIZER_IDENTITIES_FAILURE" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 401
},
"AUTH_FAILURE" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 401
},
"AUTH_HEADER_MISSING" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 401
},
"BACKEND_TIMEOUT" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 504
},
"BACKEND_UNAVAILABLE" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 502
},
"DEFAULT_4XX" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true
},
"DEFAULT_5XX" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true
},
"NOT_FOUND" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 404
},
"REQUEST_PARAMETERS_FAILURE" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 400
},
"THROTTLED" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 429
},
"UNAUTHORIZED" : {
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
"default" : true,
"status" : 401
}
}
}</pre>
<p id="CreateGatewayResponseV2_1__p23635112481"><strong id="CreateGatewayResponseV2_1__b236381119484">Status code: 400</strong></p>
<p id="CreateGatewayResponseV2_1__p10363151111486">Bad Request</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen43632118485">{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}</pre>
<p id="CreateGatewayResponseV2_1__p53641113489"><strong id="CreateGatewayResponseV2_1__b73642119483">Status code: 401</strong></p>
<p id="CreateGatewayResponseV2_1__p153641411134817">Unauthorized</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen163641011184814">{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}</pre>
<p id="CreateGatewayResponseV2_1__p11364101154819"><strong id="CreateGatewayResponseV2_1__b19364121114489">Status code: 403</strong></p>
<p id="CreateGatewayResponseV2_1__p173641611184813">Forbidden</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen1336418112483">{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}</pre>
<p id="CreateGatewayResponseV2_1__p103641111144818"><strong id="CreateGatewayResponseV2_1__b133641011144810">Status code: 404</strong></p>
<p id="CreateGatewayResponseV2_1__p6364131134815">Not Found</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen536461194817">{
"error_code" : "APIG.3001",
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}</pre>
<p id="CreateGatewayResponseV2_1__p19364311124810"><strong id="CreateGatewayResponseV2_1__b19364211184814">Status code: 500</strong></p>
<p id="CreateGatewayResponseV2_1__p14364121114483">Internal Server Error</p>
<pre class="screen" id="CreateGatewayResponseV2_1__screen83642115481">{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}</pre>
</div>
<div class="section" id="CreateGatewayResponseV2_1__section2036531104812"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2_1__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateGatewayResponseV2_1__row11635210144814"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateGatewayResponseV2_1__p15365131154816">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateGatewayResponseV2_1__p173651011184818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateGatewayResponseV2_1__row1763512103485"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateGatewayResponseV2_1__p1436511124815">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateGatewayResponseV2_1__p16365611114814">Created</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row86351510154812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateGatewayResponseV2_1__p436551164815">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateGatewayResponseV2_1__p236541117487">Bad Request</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row9636191024820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateGatewayResponseV2_1__p153651711194820">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateGatewayResponseV2_1__p9365121164811">Unauthorized</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row1063641034810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateGatewayResponseV2_1__p14365161113488">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateGatewayResponseV2_1__p17365171114816">Forbidden</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row1363616100485"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateGatewayResponseV2_1__p14365171114488">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateGatewayResponseV2_1__p63651911204810">Not Found</p>
</td>
</tr>
<tr id="CreateGatewayResponseV2_1__row146361510174819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateGatewayResponseV2_1__p336581115485">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateGatewayResponseV2_1__p3365181111484">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateGatewayResponseV2_1__section14365161194810"><h4 class="sectiontitle">Error Codes</h4><p id="CreateGatewayResponseV2_1__p436591117483">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="GroupResponseManagement_1.html">Group Response Management</a></div>
</div>
</div>
View Git Blame Copy Permalink