vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/apig/api-ref/ListGatewayResponsesV2.html
Hasko, Vladimir f3362c7fd1 re-introduce APIG API 20240125 version 
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2024-11-05 13:07:40 +00:00

508 lines
38 KiB
HTML
Raw Blame History

<a name="ListGatewayResponsesV2"></a><a name="ListGatewayResponsesV2"></a>
<h1 class="topictitle1">Querying Group Responses</h1>
<div id="body168261971201"><div class="section" id="ListGatewayResponsesV2__section582615719202"><h4 class="sectiontitle">Function</h4><p id="ListGatewayResponsesV2__p9827773209">This API is used to query the responses of an API group.</p>
</div>
<div class="section" id="ListGatewayResponsesV2__section108271073203"><h4 class="sectiontitle">Calling Method</h4><p id="ListGatewayResponsesV2__p482797142012">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
</div>
<div class="section" id="ListGatewayResponsesV2__section182767122015"><h4 class="sectiontitle">URI</h4><p id="ListGatewayResponsesV2__p11828207192016">GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__table17829167152016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row68281773208"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ListGatewayResponsesV2__p1082918710206">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ListGatewayResponsesV2__p5830378201">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ListGatewayResponsesV2__p1283018710209">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ListGatewayResponsesV2__p20830167192017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row148281873204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListGatewayResponsesV2__p58311279209">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListGatewayResponsesV2__p683147162019">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListGatewayResponsesV2__p383112782016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListGatewayResponsesV2__p1983217202015">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="ListGatewayResponsesV2__row138291875207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListGatewayResponsesV2__p2832197132019">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListGatewayResponsesV2__p128324713204">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListGatewayResponsesV2__p18331712206">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListGatewayResponsesV2__p17833167142015">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1482910742011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ListGatewayResponsesV2__p1183318782011">group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ListGatewayResponsesV2__p19834117112018">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ListGatewayResponsesV2__p168348712207">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ListGatewayResponsesV2__p18341974201">API group ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__table1383518714204" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row1783513782015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ListGatewayResponsesV2__p18369762012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ListGatewayResponsesV2__p683616714208">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ListGatewayResponsesV2__p7836177122016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ListGatewayResponsesV2__p158368718204">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row1983519792015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListGatewayResponsesV2__p28378720202">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListGatewayResponsesV2__p178371775201">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListGatewayResponsesV2__p1683713722011">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListGatewayResponsesV2__p7838375203">Offset from which the query starts. If the value is less than 0, it is automatically converted to 0.</p>
<p id="ListGatewayResponsesV2__p14838779203">Default: <strong id="ListGatewayResponsesV2__b38383742010">0</strong></p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row8835174203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ListGatewayResponsesV2__p1183916702013">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ListGatewayResponsesV2__p1283916710209">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ListGatewayResponsesV2__p1683947152012">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ListGatewayResponsesV2__p108390719209">Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500.</p>
<p id="ListGatewayResponsesV2__p78402742019">Minimum: <strong id="ListGatewayResponsesV2__b48402713208">1</strong></p>
<p id="ListGatewayResponsesV2__p7840475204">Maximum: <strong id="ListGatewayResponsesV2__b18840674203">500</strong></p>
<p id="ListGatewayResponsesV2__p1684018714201">Default: <strong id="ListGatewayResponsesV2__b1184020716201">20</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGatewayResponsesV2__section1284016782014"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row7841197122010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ListGatewayResponsesV2__p1784217772016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ListGatewayResponsesV2__p0842157182018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ListGatewayResponsesV2__p28420752011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ListGatewayResponsesV2__p484310772017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row284147182013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ListGatewayResponsesV2__p148433714204">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ListGatewayResponsesV2__p98431772017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ListGatewayResponsesV2__p1384311713208">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ListGatewayResponsesV2__p0844107112013">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="ListGatewayResponsesV2__section284411752018"><h4 class="sectiontitle">Response Parameters</h4><p id="ListGatewayResponsesV2__p118443716209"><strong id="ListGatewayResponsesV2__b98441877207">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__response_ResponsesInfoPage" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row884518718206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ListGatewayResponsesV2__p6846876206">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ListGatewayResponsesV2__p68461672204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ListGatewayResponsesV2__p08461714206">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row1784513713209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListGatewayResponsesV2__p484713718207">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListGatewayResponsesV2__p198475716203">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListGatewayResponsesV2__p1184737152010">Length of the returned resource list.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row178457711206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListGatewayResponsesV2__p11847872204">total</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListGatewayResponsesV2__p20848117172020">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListGatewayResponsesV2__p384813792012">Number of resources that match the query conditions.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1584517712202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ListGatewayResponsesV2__p138481715204">responses</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ListGatewayResponsesV2__p1984815714209">Array of <a href="#ListGatewayResponsesV2__response_ResponsesInfo">ResponsesInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ListGatewayResponsesV2__p16849675203">Response list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListGatewayResponsesV2__response_ResponsesInfo"></a><a name="response_ResponsesInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__response_ResponsesInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponsesInfo</caption><thead align="left"><tr id="ListGatewayResponsesV2__row58491278203"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="ListGatewayResponsesV2__p68501478204">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="ListGatewayResponsesV2__p685112772013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="ListGatewayResponsesV2__p98520752013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row78495718206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListGatewayResponsesV2__p1485219722016">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListGatewayResponsesV2__p10852773203">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListGatewayResponsesV2__p78536719203">Response name.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1884910782017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListGatewayResponsesV2__p1853167192017">responses</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListGatewayResponsesV2__p98545782010">Map&lt;String,<a href="#ListGatewayResponsesV2__response_ResponseInfoResp">ResponseInfoResp</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListGatewayResponsesV2__p4854175207">Response type definition. key indicates the error type. Options of key:</p>
<ul id="ListGatewayResponsesV2__ul5855107182017"><li id="ListGatewayResponsesV2__li18855578204">AUTH_FAILURE: Authentication failed.</li><li id="ListGatewayResponsesV2__li1085518742017">AUTH_HEADER_MISSING: The identity source is missing.</li><li id="ListGatewayResponsesV2__li1085516742013">AUTHORIZER_FAILURE: Custom authentication failed.</li><li id="ListGatewayResponsesV2__li18561176202">AUTHORIZER_CONF_FAILURE: Custom authorizer error.</li><li id="ListGatewayResponsesV2__li14856977205">AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.</li><li id="ListGatewayResponsesV2__li285619718209">BACKEND_UNAVAILABLE: The backend is unavailable.</li><li id="ListGatewayResponsesV2__li9856107192019">BACKEND_TIMEOUT: Backend timed out.</li><li id="ListGatewayResponsesV2__li168574717200">THROTTLED: The request was rejected due to request throttling.</li><li id="ListGatewayResponsesV2__li168571772207">UNAUTHORIZED: The app you are using has not been authorized to call the API.</li><li id="ListGatewayResponsesV2__li178571475209">ACCESS_DENIED: Access denied.</li><li id="ListGatewayResponsesV2__li1885810713206">NOT_FOUND: No API is found.</li><li id="ListGatewayResponsesV2__li685817152014">REQUEST_PARAMETERS_FAILURE: Invalid request parameter.</li><li id="ListGatewayResponsesV2__li108599712010">DEFAULT_4XX: Default 4XX error occurred.</li><li id="ListGatewayResponsesV2__li1685920716202">DEFAULT_5XX: Default 5XX error occurred.</li><li id="ListGatewayResponsesV2__li1685967172013">THIRD_AUTH_FAILURE: Third-party authentication failed.</li><li id="ListGatewayResponsesV2__li585987182012">THIRD_AUTH_IDENTITIES_FAILURE: Identity source of the third-party authorizer is invalid.</li><li id="ListGatewayResponsesV2__li886016742015">THIRD_AUTH_CONF_FAILURE: Third-party authorizer configuration error.</li><li id="ListGatewayResponsesV2__li7860276205">ORCHESTRATION_PARAMETER_NOT_FOUND: No parameters are input to match the parameter orchestration rule, causing orchestration failure.</li><li id="ListGatewayResponsesV2__li886010712203">ORCHESTRATION_FAILURE: Input parameters cannot match orchestration rules, causing orchestration failure.</li></ul>
<p id="ListGatewayResponsesV2__p7861871203">Each error type is in JSON format.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row118506713204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListGatewayResponsesV2__p13861197182018">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListGatewayResponsesV2__p286117732014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListGatewayResponsesV2__p78622742010">Response ID.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row78507742013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListGatewayResponsesV2__p1486219716203">default</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListGatewayResponsesV2__p2863157172014">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListGatewayResponsesV2__p886316792014">Indicates whether the group response is the default response.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row148501376203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListGatewayResponsesV2__p198637792020">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListGatewayResponsesV2__p28645712208">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListGatewayResponsesV2__p108648792018">Creation time.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row185015710203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ListGatewayResponsesV2__p1686497182014">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ListGatewayResponsesV2__p208648713209">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ListGatewayResponsesV2__p1865137182015">Update time.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListGatewayResponsesV2__response_ResponseInfoResp"></a><a name="response_ResponseInfoResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__response_ResponseInfoResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ResponseInfoResp</caption><thead align="left"><tr id="ListGatewayResponsesV2__row986512715207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ListGatewayResponsesV2__p686610732011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ListGatewayResponsesV2__p198671071202">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ListGatewayResponsesV2__p18671579207">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row38657711205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ListGatewayResponsesV2__p1986714715202">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ListGatewayResponsesV2__p13868197192014">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ListGatewayResponsesV2__p1686887182015">HTTP status code of the response. The value ranges from 200 to 599, but cannot be 444.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row19865167182012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ListGatewayResponsesV2__p168691275206">body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ListGatewayResponsesV2__p2869157102020">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ListGatewayResponsesV2__p38696742011">Response body template.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1986610792012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ListGatewayResponsesV2__p48705762016">headers</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ListGatewayResponsesV2__p1787012732015">Array of <a href="#ListGatewayResponsesV2__response_ResponseInfoHeader">ResponseInfoHeader</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ListGatewayResponsesV2__p17871117182017">Custom response header.</p>
<p id="ListGatewayResponsesV2__p78716742014">Array Length: <strong id="ListGatewayResponsesV2__b28716719205">0 - 10</strong></p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row68665713206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ListGatewayResponsesV2__p138717772020">default</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ListGatewayResponsesV2__p68717710204">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ListGatewayResponsesV2__p5872157102013">Indicates whether the response is the default response.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListGatewayResponsesV2__response_ResponseInfoHeader"></a><a name="response_ResponseInfoHeader"></a><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__response_ResponseInfoHeader" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ResponseInfoHeader</caption><thead align="left"><tr id="ListGatewayResponsesV2__row1287387132016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="ListGatewayResponsesV2__p387467112015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="ListGatewayResponsesV2__p587437152015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="ListGatewayResponsesV2__p8874107112014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row18873573207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="ListGatewayResponsesV2__p387597112019">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="ListGatewayResponsesV2__p1287515719203">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="ListGatewayResponsesV2__p1687527162014">Key of the custom group response header, which can contain 1 to 128 characters of letters, digits, and hyphens (-).</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row158735772019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="ListGatewayResponsesV2__p987617772018">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="ListGatewayResponsesV2__p10876187192015">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="ListGatewayResponsesV2__p18768713209">Value of the custom group response header, which is a string of 1 to 1,024 characters.</p>
<p id="ListGatewayResponsesV2__p128771476208">Minimum: <strong id="ListGatewayResponsesV2__b118777710202">1</strong></p>
<p id="ListGatewayResponsesV2__p1287717182014">Maximum: <strong id="ListGatewayResponsesV2__b13877071201">1024</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListGatewayResponsesV2__p287717752017"><strong id="ListGatewayResponsesV2__b287887182010">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row48789711202"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="ListGatewayResponsesV2__p2087917772015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="ListGatewayResponsesV2__p19879147182015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="ListGatewayResponsesV2__p1880127172019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row1787811732018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="ListGatewayResponsesV2__p1988017112015">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="ListGatewayResponsesV2__p38815732014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="ListGatewayResponsesV2__p15881167142014">Error code.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row208781782010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="ListGatewayResponsesV2__p488177172010">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="ListGatewayResponsesV2__p188210792016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="ListGatewayResponsesV2__p5882117202010">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListGatewayResponsesV2__p1688220711204"><strong id="ListGatewayResponsesV2__b288297172015">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__table138836715206" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row168838715204"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p id="ListGatewayResponsesV2__p1788415742016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.2"><p id="ListGatewayResponsesV2__p1388417152013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.10.2.4.1.3"><p id="ListGatewayResponsesV2__p888414712209">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row38831572200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="ListGatewayResponsesV2__p1088597112015">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="ListGatewayResponsesV2__p168851071209">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="ListGatewayResponsesV2__p08858713207">Error code.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row5883175208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="ListGatewayResponsesV2__p13886476206">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="ListGatewayResponsesV2__p388627162018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="ListGatewayResponsesV2__p11886197102011">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListGatewayResponsesV2__p6886147142012"><strong id="ListGatewayResponsesV2__b1388613714204">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__table138864710201" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row118874715207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="ListGatewayResponsesV2__p2888577206">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p id="ListGatewayResponsesV2__p488815792012">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p id="ListGatewayResponsesV2__p38889792012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row688767152015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="ListGatewayResponsesV2__p1688911717203">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="ListGatewayResponsesV2__p11889117102010">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="ListGatewayResponsesV2__p5889157112010">Error code.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1588714782019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="ListGatewayResponsesV2__p8889475208">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="ListGatewayResponsesV2__p38908714209">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="ListGatewayResponsesV2__p1890127172019">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListGatewayResponsesV2__p0890107122011"><strong id="ListGatewayResponsesV2__b2089010719202">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__table2890147132010" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row208913732015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.1"><p id="ListGatewayResponsesV2__p1689120719209">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.2"><p id="ListGatewayResponsesV2__p38929717203">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.14.2.4.1.3"><p id="ListGatewayResponsesV2__p138924720205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row148913792018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="ListGatewayResponsesV2__p18926716201">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="ListGatewayResponsesV2__p178933712201">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="ListGatewayResponsesV2__p889316702016">Error code.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row198919732015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="ListGatewayResponsesV2__p18894272201">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="ListGatewayResponsesV2__p198943782012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="ListGatewayResponsesV2__p4894574204">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListGatewayResponsesV2__p18948732018"><strong id="ListGatewayResponsesV2__b1989510716202">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__table14895167142012" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="ListGatewayResponsesV2__row158956719204"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.1"><p id="ListGatewayResponsesV2__p188961677208">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.16.2.4.1.2"><p id="ListGatewayResponsesV2__p98971782015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.16.2.4.1.3"><p id="ListGatewayResponsesV2__p28971771201">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row158958772018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p id="ListGatewayResponsesV2__p789715713206">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p id="ListGatewayResponsesV2__p158971974204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p id="ListGatewayResponsesV2__p677118172011">Error code.</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row11895127152014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.1 "><p id="ListGatewayResponsesV2__p1177188207">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.16.2.4.1.2 "><p id="ListGatewayResponsesV2__p1771688204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.16.2.4.1.3 "><p id="ListGatewayResponsesV2__p157718162019">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGatewayResponsesV2__section7771986204"><h4 class="sectiontitle">Example Requests</h4><p id="ListGatewayResponsesV2__p107778192017">None</p>
</div>
<div class="section" id="ListGatewayResponsesV2__section1377118122016"><h4 class="sectiontitle">Example Responses</h4><p id="ListGatewayResponsesV2__p278158122019"><strong id="ListGatewayResponsesV2__b87858112014">Status code: 200</strong></p>
<p id="ListGatewayResponsesV2__p27858182010">OK</p>
<pre class="screen" id="ListGatewayResponsesV2__screen9783862011">{
"total" : 2,
"size" : 2,
"responses" : [ {
"create_time" : "2020-08-12T06:52:02Z",
"default" : false,
"id" : "e839b367e10f4ab19d1c5008e476b83a",
"name" : "response_demo",
"update_time" : "2020-08-12T06:52:02Z"
}, {
"create_time" : "2020-07-31T11:39:23Z",
"default" : true,
"id" : "ed8e8c52ab0e4a1c9c809268e5002e64",
"name" : "default",
"update_time" : "2020-07-31T11:39:23Z"
} ]
}</pre>
<p id="ListGatewayResponsesV2__p168210810205"><strong id="ListGatewayResponsesV2__b98298152011">Status code: 400</strong></p>
<p id="ListGatewayResponsesV2__p1382381201">Bad Request</p>
<pre class="screen" id="ListGatewayResponsesV2__screen28288112017">{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:group_id. Please refer to the support documentation"
}</pre>
<p id="ListGatewayResponsesV2__p78213815203"><strong id="ListGatewayResponsesV2__b15823820205">Status code: 401</strong></p>
<p id="ListGatewayResponsesV2__p2823812204">Unauthorized</p>
<pre class="screen" id="ListGatewayResponsesV2__screen108219811207">{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}</pre>
<p id="ListGatewayResponsesV2__p48313817206"><strong id="ListGatewayResponsesV2__b14836822017">Status code: 403</strong></p>
<p id="ListGatewayResponsesV2__p138318802018">Forbidden</p>
<pre class="screen" id="ListGatewayResponsesV2__screen14838817209">{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}</pre>
<p id="ListGatewayResponsesV2__p28318182020"><strong id="ListGatewayResponsesV2__b98316810201">Status code: 404</strong></p>
<p id="ListGatewayResponsesV2__p1283148192018">Not Found</p>
<pre class="screen" id="ListGatewayResponsesV2__screen198311814208">{
"error_code" : "APIG.3001",
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}</pre>
<p id="ListGatewayResponsesV2__p38417862019"><strong id="ListGatewayResponsesV2__b384108102016">Status code: 500</strong></p>
<p id="ListGatewayResponsesV2__p168438152015">Internal Server Error</p>
<pre class="screen" id="ListGatewayResponsesV2__screen1684158172016">{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}</pre>
</div>
<div class="section" id="ListGatewayResponsesV2__section484178182010"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGatewayResponsesV2__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListGatewayResponsesV2__row790737102014"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ListGatewayResponsesV2__p4846815200">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ListGatewayResponsesV2__p158438192020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGatewayResponsesV2__row179073712016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListGatewayResponsesV2__p108458122011">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListGatewayResponsesV2__p118498132011">OK</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row10907573208"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListGatewayResponsesV2__p28520892016">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListGatewayResponsesV2__p085385202">Bad Request</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row179079732016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListGatewayResponsesV2__p28598132013">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListGatewayResponsesV2__p12857822015">Unauthorized</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1990712718209"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListGatewayResponsesV2__p18518202011">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListGatewayResponsesV2__p1385288209">Forbidden</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row1390717715205"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListGatewayResponsesV2__p2085087208">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListGatewayResponsesV2__p685118182017">Not Found</p>
</td>
</tr>
<tr id="ListGatewayResponsesV2__row2090711792010"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ListGatewayResponsesV2__p3852832018">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ListGatewayResponsesV2__p168517852010">Internal Server Error</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGatewayResponsesV2__section18511832019"><h4 class="sectiontitle">Error Codes</h4><p id="ListGatewayResponsesV2__p285128102011">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.html">Group Response Management</a></div>
</div>
</div>
View Git Blame Copy Permalink