forked from docs/doc-exports
Chen, Junjie
710480502f
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
471 lines
34 KiB
HTML
471 lines
34 KiB
HTML
<a name="ShowDetailsOfGatewayResponseV2_1"></a><a name="ShowDetailsOfGatewayResponseV2_1"></a>
|
|
|
|
<h1 class="topictitle1">Querying Group Response Details</h1>
|
|
<div id="body39650682420"><div class="section" id="ShowDetailsOfGatewayResponseV2_1__section696596152417"><h4 class="sectiontitle">Function</h4><p id="ShowDetailsOfGatewayResponseV2_1__p129668682414">This API is used to query the details of a response defined for an API group.</p>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="ShowDetailsOfGatewayResponseV2_1__p109691269242">GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses/{response_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__table11972186152417" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row69701763242"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p12972461242">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p1097315652415">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p9974061249">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowDetailsOfGatewayResponseV2_1__p1297518642417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row49701369246"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p2976116112418">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p1197696112413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p119771867244">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfGatewayResponseV2_1__p79789611244">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="ShowDetailsOfGatewayResponseV2_1__row697116612410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p79799692414">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p189791760246">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p1798012615248">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfGatewayResponseV2_1__p109816619246">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row1697126102419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p14982268241">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p199824682414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p3983176162417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfGatewayResponseV2_1__p598418619240">API group ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row119719613249"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p10985146112418">response_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p1598520642417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p898617617242">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfGatewayResponseV2_1__p1998720617246">Response ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__section16987106152411"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row29895692418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p19903622418">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p15991263249">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p49911965247">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowDetailsOfGatewayResponseV2_1__p6992165241">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row16989660246"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p14993169241">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p99940618244">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p1199426122417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowDetailsOfGatewayResponseV2_1__p4995106182415">User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__section8996968241"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowDetailsOfGatewayResponseV2_1__p149972616248"><strong id="ShowDetailsOfGatewayResponseV2_1__b18997136152417">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ResponsesInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row159980642417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p9015711242">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p604714243">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p14111752413">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row139989614241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p1927710245">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p520762413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p93371247">Response name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row1199816112413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p13414742412">responses</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p19410711242">Map<String,<a href="#ShowDetailsOfGatewayResponseV2_1__response_ResponseInfoResp">ResponseInfoResp</a>></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p13518732411">Response type definition. key indicates the error type. Options of key:</p>
|
|
<ul id="ShowDetailsOfGatewayResponseV2_1__ul15612717241"><li id="ShowDetailsOfGatewayResponseV2_1__li16614717245">AUTH_FAILURE: Authentication failed.</li><li id="ShowDetailsOfGatewayResponseV2_1__li137127182412">AUTH_HEADER_MISSING: The identity source is missing.</li><li id="ShowDetailsOfGatewayResponseV2_1__li16812712241">AUTHORIZER_FAILURE: Custom authentication failed.</li><li id="ShowDetailsOfGatewayResponseV2_1__li12815710244">AUTHORIZER_CONF_FAILURE: Custom authorizer error.</li><li id="ShowDetailsOfGatewayResponseV2_1__li16919718242">AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.</li><li id="ShowDetailsOfGatewayResponseV2_1__li4107742414">BACKEND_UNAVAILABLE: The backend is unavailable.</li><li id="ShowDetailsOfGatewayResponseV2_1__li0108710240">BACKEND_TIMEOUT: Backend timed out.</li><li id="ShowDetailsOfGatewayResponseV2_1__li19112072246">THROTTLED: The request was rejected due to request throttling.</li><li id="ShowDetailsOfGatewayResponseV2_1__li9123719249">UNAUTHORIZED: The app you are using has not been authorized to call the API.</li><li id="ShowDetailsOfGatewayResponseV2_1__li112167182418">ACCESS_DENIED: Access denied.</li><li id="ShowDetailsOfGatewayResponseV2_1__li14134720242">NOT_FOUND: No API is found.</li><li id="ShowDetailsOfGatewayResponseV2_1__li1814137152416">REQUEST_PARAMETERS_FAILURE: Invalid request parameter.</li><li id="ShowDetailsOfGatewayResponseV2_1__li14149713241">DEFAULT_4XX: Default 4XX error occurred.</li><li id="ShowDetailsOfGatewayResponseV2_1__li10151278246">DEFAULT_5XX: Default 5XX error occurred.</li></ul>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p518107192417">Each error type is in JSON format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row19982652420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p618107192411">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p191911712246">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p19200732417">Response ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row5998186172413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p13201372243">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p6219782413">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p122237102413">Indicates whether the group response is the default response.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row199986614245"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p15225772420">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p523177172410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p182420718245">Creation time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row99981765244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p1924107102416">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p1225127122419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p326673246">Update time.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowDetailsOfGatewayResponseV2_1__response_ResponseInfoResp"></a><a name="response_ResponseInfoResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ResponseInfoResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseInfoResp</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row10271715246"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p22819712247">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p129676243">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p1830272249">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row82717710247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p20306762416">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p53116792417">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p183215714246">HTTP status code of the response.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row32711782418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p123207132420">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p8330711249">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p133457102414">Response body template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row192715716243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p334571241">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p53711713245">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p438076246">Indicates whether the response is the default response.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p139474242"><strong id="ShowDetailsOfGatewayResponseV2_1__b5390713247">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row740974247"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p1641172243">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p04247152413">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p1642878241">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row140974241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p174317162418">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p194412722410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p04511712411">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row124020712245"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p945870243">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p54627202417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p1647167112417">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p164719714241"><strong id="ShowDetailsOfGatewayResponseV2_1__b19486711242">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row174817719243"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p95013732416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p12519719249">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p115117762412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row12481075242"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p95219712416">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p4535732411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p6537762417">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row84812752418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p65418720247">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p1155197152410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p14561772243">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p15561702417"><strong id="ShowDetailsOfGatewayResponseV2_1__b15618717247">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row16571976244"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p859167102412">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p16601717246">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p16610712246">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row557107132410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p1862137182412">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p126216710249">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p86312712415">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row185719716243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p12642722410">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p1656762418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p1165197192414">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p166611716241"><strong id="ShowDetailsOfGatewayResponseV2_1__b1666157122415">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row5673762413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p868777241">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p16911712419">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p5704713246">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row17671715243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p570178241">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p071271243">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p17216702412">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row967207182420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p2739742415">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p7736792418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p07487172413">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p197517152413"><strong id="ShowDetailsOfGatewayResponseV2_1__b27537182415">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row07627112414"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p137915714243">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p4808752416">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.14.2.4.1.3"><p id="ShowDetailsOfGatewayResponseV2_1__p178119772415">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row07747162417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p14821078245">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p2829716246">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p38313718245">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row67713715247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p9841179248">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p13851671243">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfGatewayResponseV2_1__p8861271241">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__section8866711245"><h4 class="sectiontitle">Example Requests</h4><p id="ShowDetailsOfGatewayResponseV2_1__p38715732419">None</p>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__section1889137102418"><h4 class="sectiontitle">Example Responses</h4><p id="ShowDetailsOfGatewayResponseV2_1__p6902071246"><strong id="ShowDetailsOfGatewayResponseV2_1__b18906772420">Status code: 200</strong></p>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p7901171243">Created</p>
|
|
<pre class="screen" id="ShowDetailsOfGatewayResponseV2_1__screen1698970246">{
|
|
"create_time" : "2020-08-12T06:52:02Z",
|
|
"update_time" : "2020-08-12T06:52:02Z",
|
|
"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="ShowDetailsOfGatewayResponseV2_1__p527118112418"><strong id="ShowDetailsOfGatewayResponseV2_1__b5271887241">Status code: 400</strong></p>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p02778122414">Bad Request</p>
|
|
<pre class="screen" id="ShowDetailsOfGatewayResponseV2_1__screen32716816246">{
|
|
"error_code" : "APIG.2012",
|
|
"error_msg" : "Invalid parameter value,parameterName:group_id. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p16281286244"><strong id="ShowDetailsOfGatewayResponseV2_1__b228387249">Status code: 401</strong></p>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p122810892416">Unauthorized</p>
|
|
<pre class="screen" id="ShowDetailsOfGatewayResponseV2_1__screen152818842411">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p14284813245"><strong id="ShowDetailsOfGatewayResponseV2_1__b14286811248">Status code: 403</strong></p>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p22815832416">Forbidden</p>
|
|
<pre class="screen" id="ShowDetailsOfGatewayResponseV2_1__screen11284862420">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p1728148202413"><strong id="ShowDetailsOfGatewayResponseV2_1__b16283812248">Status code: 404</strong></p>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p1428688242">Not Found</p>
|
|
<pre class="screen" id="ShowDetailsOfGatewayResponseV2_1__screen928686245">{
|
|
"error_code" : "APIG.3001",
|
|
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
|
|
}</pre>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p172818102411"><strong id="ShowDetailsOfGatewayResponseV2_1__b11285872410">Status code: 500</strong></p>
|
|
<p id="ShowDetailsOfGatewayResponseV2_1__p102817820246">Internal Server Error</p>
|
|
<pre class="screen" id="ShowDetailsOfGatewayResponseV2_1__screen142998122416">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__section1929148122410"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfGatewayResponseV2_1__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowDetailsOfGatewayResponseV2_1__row21596712417"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowDetailsOfGatewayResponseV2_1__p92917862411">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowDetailsOfGatewayResponseV2_1__p12998152410">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowDetailsOfGatewayResponseV2_1__row1215947102410"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p92919892413">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p72978202413">Created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row91594772417"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p16295842415">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p5293810248">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row9159673248"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p5291811246">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p112918852411">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row19159870249"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p16299802413">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p122913872412">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row11159376249"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p18292882410">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p5291881243">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowDetailsOfGatewayResponseV2_1__row615911710244"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfGatewayResponseV2_1__p112915816241">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfGatewayResponseV2_1__p11302084243">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowDetailsOfGatewayResponseV2_1__section23015818247"><h4 class="sectiontitle">Error Codes</h4><p id="ShowDetailsOfGatewayResponseV2_1__p163068202416">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>
|
|
|