forked from docs/doc-exports
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
627 lines
47 KiB
HTML
627 lines
47 KiB
HTML
<a name="CreateGatewayResponseV2"></a><a name="CreateGatewayResponseV2"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Group Response</h1>
|
|
<div id="body1321114821820"><div class="section" id="CreateGatewayResponseV2__section6321204831810"><h4 class="sectiontitle">Function</h4><p id="CreateGatewayResponseV2__p14321124881813">This API is used to create a response for an API group.</p>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section532124831816"><h4 class="sectiontitle">Calling Method</h4><p id="CreateGatewayResponseV2__p19322194891815">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section33226489183"><h4 class="sectiontitle">URI</h4><p id="CreateGatewayResponseV2__p123221848161819">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__table832524831819" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row53232048131817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateGatewayResponseV2__p1232520483187">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateGatewayResponseV2__p1632534814181">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateGatewayResponseV2__p8325104813188">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateGatewayResponseV2__p3325134818189">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row133231748121819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateGatewayResponseV2__p143266481187">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateGatewayResponseV2__p3326548101815">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateGatewayResponseV2__p19326154861814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateGatewayResponseV2__p5326204811814">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__row133241948201814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateGatewayResponseV2__p14326164815189">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateGatewayResponseV2__p8327144817181">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateGatewayResponseV2__p1532718486183">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateGatewayResponseV2__p132710489184">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row203241448181811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateGatewayResponseV2__p53271048161817">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateGatewayResponseV2__p6327164841811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateGatewayResponseV2__p17328114881820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateGatewayResponseV2__p16328204801816">API group ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section532814484182"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row8328124841810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="CreateGatewayResponseV2__p1932944851813">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="CreateGatewayResponseV2__p1232915481182">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="CreateGatewayResponseV2__p4329104816189">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="CreateGatewayResponseV2__p6331134819187">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row4328548111810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="CreateGatewayResponseV2__p633216483182">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="CreateGatewayResponseV2__p9332104818186">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="CreateGatewayResponseV2__p20332124819185">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="CreateGatewayResponseV2__p8332348191818">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__request_ResponsesCreate" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row133337481182"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="CreateGatewayResponseV2__p1733474811818">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="CreateGatewayResponseV2__p2334134813185">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="CreateGatewayResponseV2__p33351248141810">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="CreateGatewayResponseV2__p113351648151817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row73331487185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="CreateGatewayResponseV2__p2335164841810">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="CreateGatewayResponseV2__p10335148151812">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="CreateGatewayResponseV2__p433518485181">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="CreateGatewayResponseV2__p133684851816">Response name. Enter 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row9333104819186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="CreateGatewayResponseV2__p1233619486181">responses</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="CreateGatewayResponseV2__p10336204841818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="CreateGatewayResponseV2__p15336174841817">Map<String,<a href="#CreateGatewayResponseV2__request_ResponseInfo">ResponseInfo</a>></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="CreateGatewayResponseV2__p1633704811816">Response type definition. key indicates the error type. Options of key:</p>
|
|
<ul id="CreateGatewayResponseV2__ul1733712481189"><li id="CreateGatewayResponseV2__li433754818182">AUTH_FAILURE: Authentication failed.</li><li id="CreateGatewayResponseV2__li33376483189">AUTH_HEADER_MISSING: The identity source is missing.</li><li id="CreateGatewayResponseV2__li933764861811">AUTHORIZER_FAILURE: Custom authentication failed.</li><li id="CreateGatewayResponseV2__li1633784810186">AUTHORIZER_CONF_FAILURE: Custom authorizer error.</li><li id="CreateGatewayResponseV2__li133381148181810">AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.</li><li id="CreateGatewayResponseV2__li19338114819181">BACKEND_UNAVAILABLE: The backend is unavailable.</li><li id="CreateGatewayResponseV2__li93381481186">BACKEND_TIMEOUT: Backend timed out.</li><li id="CreateGatewayResponseV2__li3338104812184">THROTTLED: The request was rejected due to request throttling.</li><li id="CreateGatewayResponseV2__li4338124871817">UNAUTHORIZED: The app you are using has not been authorized to call the API.</li><li id="CreateGatewayResponseV2__li183396480188">ACCESS_DENIED: Access denied.</li><li id="CreateGatewayResponseV2__li1339114817188">NOT_FOUND: No API is found.</li><li id="CreateGatewayResponseV2__li1339124814186">REQUEST_PARAMETERS_FAILURE: Invalid request parameter.</li><li id="CreateGatewayResponseV2__li183391748151817">DEFAULT_4XX: Default 4XX error occurred.</li><li id="CreateGatewayResponseV2__li6339948101818">DEFAULT_5XX: Default 5XX error occurred.</li><li id="CreateGatewayResponseV2__li183401248141810">THIRD_AUTH_FAILURE: Third-party authentication failed.</li><li id="CreateGatewayResponseV2__li1534094811183">THIRD_AUTH_IDENTITIES_FAILURE: Identity source of the third-party authorizer is invalid.</li><li id="CreateGatewayResponseV2__li113404484180">THIRD_AUTH_CONF_FAILURE: Third-party authorizer configuration error.</li><li id="CreateGatewayResponseV2__li163401048121818">ORCHESTRATION_PARAMETER_NOT_FOUND: No parameters are input to match the parameter orchestration rule, causing orchestration failure.</li><li id="CreateGatewayResponseV2__li33401548191818">ORCHESTRATION_FAILURE: Input parameters cannot match orchestration rules, causing orchestration failure.</li></ul>
|
|
<p id="CreateGatewayResponseV2__p13418486181">Each error type is in JSON format.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateGatewayResponseV2__request_ResponseInfo"></a><a name="request_ResponseInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__request_ResponseInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ResponseInfo</caption><thead align="left"><tr id="CreateGatewayResponseV2__row17341134816186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="CreateGatewayResponseV2__p7343114820183">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="CreateGatewayResponseV2__p1234312488187">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="CreateGatewayResponseV2__p1343134814185">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="CreateGatewayResponseV2__p934334813181">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row10342144861811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateGatewayResponseV2__p534418487186">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateGatewayResponseV2__p1834415481185">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateGatewayResponseV2__p934444811187">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateGatewayResponseV2__p12344184811817">HTTP status code of the response. The value ranges from 200 to 599, but cannot be 444.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row8342348131819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateGatewayResponseV2__p634464881816">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateGatewayResponseV2__p2345114811181">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateGatewayResponseV2__p83451048111814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateGatewayResponseV2__p1334511488187">Response body template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row13421048151815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="CreateGatewayResponseV2__p1334504811188">headers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="CreateGatewayResponseV2__p173451148131820">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="CreateGatewayResponseV2__p11346748191813">Array of <a href="#CreateGatewayResponseV2__request_ResponseInfoHeader">ResponseInfoHeader</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="CreateGatewayResponseV2__p1434611489182">Custom response header.</p>
|
|
<p id="CreateGatewayResponseV2__p934612487185">Array Length: <strong id="CreateGatewayResponseV2__b14346174818183">0 - 10</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateGatewayResponseV2__request_ResponseInfoHeader"></a><a name="request_ResponseInfoHeader"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__request_ResponseInfoHeader" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ResponseInfoHeader</caption><thead align="left"><tr id="CreateGatewayResponseV2__row183461248111812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="CreateGatewayResponseV2__p17347164816188">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="CreateGatewayResponseV2__p123484481183">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="CreateGatewayResponseV2__p113480487181">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="CreateGatewayResponseV2__p934834810182">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row12347164881815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="CreateGatewayResponseV2__p153481482183">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="CreateGatewayResponseV2__p9348124817189">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="CreateGatewayResponseV2__p133491048161817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="CreateGatewayResponseV2__p2349448131817">Key of the custom group response header, which can contain 1 to 128 characters of letters, digits, and hyphens (-).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row1734704819186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="CreateGatewayResponseV2__p334994816183">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="CreateGatewayResponseV2__p4349194818184">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="CreateGatewayResponseV2__p434994813181">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="CreateGatewayResponseV2__p1735024881816">Value of the custom group response header, which is a string of 1 to 1,024 characters.</p>
|
|
<p id="CreateGatewayResponseV2__p835004801818">Minimum: <strong id="CreateGatewayResponseV2__b1035074821817">1</strong></p>
|
|
<p id="CreateGatewayResponseV2__p13501848181815">Maximum: <strong id="CreateGatewayResponseV2__b4350164813183">1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section83508488185"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateGatewayResponseV2__p1435084815187"><strong id="CreateGatewayResponseV2__b935119482186">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__response_ResponsesInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row183511484182"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="CreateGatewayResponseV2__p1535214814187">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="CreateGatewayResponseV2__p113531048191816">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="CreateGatewayResponseV2__p163531148101811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row635154816188"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateGatewayResponseV2__p1335318489182">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateGatewayResponseV2__p43531848191819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateGatewayResponseV2__p735417484181">Response name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row1735124813189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateGatewayResponseV2__p11354134881813">responses</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateGatewayResponseV2__p33541448101814">Map<String,<a href="#CreateGatewayResponseV2__response_ResponseInfoResp">ResponseInfoResp</a>></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateGatewayResponseV2__p1635415481185">Response type definition. key indicates the error type. Options of key:</p>
|
|
<ul id="CreateGatewayResponseV2__ul1335454881816"><li id="CreateGatewayResponseV2__li1135454851817">AUTH_FAILURE: Authentication failed.</li><li id="CreateGatewayResponseV2__li935514811182">AUTH_HEADER_MISSING: The identity source is missing.</li><li id="CreateGatewayResponseV2__li10355848131812">AUTHORIZER_FAILURE: Custom authentication failed.</li><li id="CreateGatewayResponseV2__li19355748121810">AUTHORIZER_CONF_FAILURE: Custom authorizer error.</li><li id="CreateGatewayResponseV2__li435518484185">AUTHORIZER_IDENTITIES_FAILURE: The identity source of the custom authorizer is invalid.</li><li id="CreateGatewayResponseV2__li23551048191811">BACKEND_UNAVAILABLE: The backend is unavailable.</li><li id="CreateGatewayResponseV2__li1735534816181">BACKEND_TIMEOUT: Backend timed out.</li><li id="CreateGatewayResponseV2__li12356124811184">THROTTLED: The request was rejected due to request throttling.</li><li id="CreateGatewayResponseV2__li15356194815180">UNAUTHORIZED: The app you are using has not been authorized to call the API.</li><li id="CreateGatewayResponseV2__li1035616487182">ACCESS_DENIED: Access denied.</li><li id="CreateGatewayResponseV2__li135614851812">NOT_FOUND: No API is found.</li><li id="CreateGatewayResponseV2__li5356144891811">REQUEST_PARAMETERS_FAILURE: Invalid request parameter.</li><li id="CreateGatewayResponseV2__li13571048101811">DEFAULT_4XX: Default 4XX error occurred.</li><li id="CreateGatewayResponseV2__li13571948181813">DEFAULT_5XX: Default 5XX error occurred.</li><li id="CreateGatewayResponseV2__li835774811188">THIRD_AUTH_FAILURE: Third-party authentication failed.</li><li id="CreateGatewayResponseV2__li203571548131819">THIRD_AUTH_IDENTITIES_FAILURE: Identity source of the third-party authorizer is invalid.</li><li id="CreateGatewayResponseV2__li1335712484184">THIRD_AUTH_CONF_FAILURE: Third-party authorizer configuration error.</li><li id="CreateGatewayResponseV2__li1935716484182">ORCHESTRATION_PARAMETER_NOT_FOUND: No parameters are input to match the parameter orchestration rule, causing orchestration failure.</li><li id="CreateGatewayResponseV2__li6358248101811">ORCHESTRATION_FAILURE: Input parameters cannot match orchestration rules, causing orchestration failure.</li></ul>
|
|
<p id="CreateGatewayResponseV2__p5358448111819">Each error type is in JSON format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row835114817180"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateGatewayResponseV2__p635854831810">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateGatewayResponseV2__p8358174881813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateGatewayResponseV2__p13358174816181">Response ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row935274841811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateGatewayResponseV2__p13598487188">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateGatewayResponseV2__p183592487187">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateGatewayResponseV2__p153601148151819">Indicates whether the group response is the default response.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row53526485185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateGatewayResponseV2__p123601148171811">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateGatewayResponseV2__p73611848141816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateGatewayResponseV2__p1936134811813">Creation time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row143521548171820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="CreateGatewayResponseV2__p336154811818">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="CreateGatewayResponseV2__p1536124819185">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="CreateGatewayResponseV2__p636213482184">Update time.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateGatewayResponseV2__response_ResponseInfoResp"></a><a name="response_ResponseInfoResp"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__response_ResponseInfoResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ResponseInfoResp</caption><thead align="left"><tr id="CreateGatewayResponseV2__row536213481183"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="CreateGatewayResponseV2__p536413486185">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="CreateGatewayResponseV2__p6366948161819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="CreateGatewayResponseV2__p143671848161815">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row11363204831811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateGatewayResponseV2__p1736734814189">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateGatewayResponseV2__p4367448181810">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateGatewayResponseV2__p10367114814187">HTTP status code of the response. The value ranges from 200 to 599, but cannot be 444.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row836304818181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateGatewayResponseV2__p63681048141814">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateGatewayResponseV2__p13368154813184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateGatewayResponseV2__p18368194821810">Response body template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row18363124811185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateGatewayResponseV2__p18368174811819">headers</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateGatewayResponseV2__p436834841816">Array of <a href="#CreateGatewayResponseV2__response_ResponseInfoHeader">ResponseInfoHeader</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateGatewayResponseV2__p336910483185">Custom response header.</p>
|
|
<p id="CreateGatewayResponseV2__p4369174851815">Array Length: <strong id="CreateGatewayResponseV2__b6369154811182">0 - 10</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row736354871817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="CreateGatewayResponseV2__p83691148121819">default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="CreateGatewayResponseV2__p1936974810180">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="CreateGatewayResponseV2__p1136910485182">Indicates whether the response is the default response.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateGatewayResponseV2__response_ResponseInfoHeader"></a><a name="response_ResponseInfoHeader"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__response_ResponseInfoHeader" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ResponseInfoHeader</caption><thead align="left"><tr id="CreateGatewayResponseV2__row4370948141816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="CreateGatewayResponseV2__p9371348121816">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="CreateGatewayResponseV2__p9371194861818">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="CreateGatewayResponseV2__p3371204821817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row9370148111815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="CreateGatewayResponseV2__p13371248171816">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="CreateGatewayResponseV2__p9371134891817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="CreateGatewayResponseV2__p73721748181820">Key of the custom group response header, which can contain 1 to 128 characters of letters, digits, and hyphens (-).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row93707485189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="CreateGatewayResponseV2__p33721148151819">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="CreateGatewayResponseV2__p9372194831816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="CreateGatewayResponseV2__p037214485182">Value of the custom group response header, which is a string of 1 to 1,024 characters.</p>
|
|
<p id="CreateGatewayResponseV2__p1737216481183">Minimum: <strong id="CreateGatewayResponseV2__b5372174831813">1</strong></p>
|
|
<p id="CreateGatewayResponseV2__p9372134810181">Maximum: <strong id="CreateGatewayResponseV2__b13372194811185">1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateGatewayResponseV2__p5373164818186"><strong id="CreateGatewayResponseV2__b143739487188">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row13373204851811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="CreateGatewayResponseV2__p1237474871812">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="CreateGatewayResponseV2__p63745488189">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="CreateGatewayResponseV2__p23741348151817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row1637394813189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="CreateGatewayResponseV2__p737454801811">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="CreateGatewayResponseV2__p1837444861819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="CreateGatewayResponseV2__p10375194851812">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row12373154811812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="CreateGatewayResponseV2__p153752481183">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="CreateGatewayResponseV2__p1737534813184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="CreateGatewayResponseV2__p937520487184">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateGatewayResponseV2__p1137510482187"><strong id="CreateGatewayResponseV2__b0375148181816">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__table1375948141819" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row18376144841814"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="CreateGatewayResponseV2__p13376134811186">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="CreateGatewayResponseV2__p5377164831816">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="CreateGatewayResponseV2__p1437716482183">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row53762488186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateGatewayResponseV2__p173771948151819">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateGatewayResponseV2__p1727449101814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateGatewayResponseV2__p72724914183">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row1837614817185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="CreateGatewayResponseV2__p72714911811">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="CreateGatewayResponseV2__p227184911812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="CreateGatewayResponseV2__p9276495181">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateGatewayResponseV2__p22715490188"><strong id="CreateGatewayResponseV2__b9271149191816">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__table1378104811187" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row1437994841815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="CreateGatewayResponseV2__p1427149171811">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="CreateGatewayResponseV2__p19271493183">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="CreateGatewayResponseV2__p18281249201815">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row183791348151819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="CreateGatewayResponseV2__p22864912183">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="CreateGatewayResponseV2__p6281949111819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="CreateGatewayResponseV2__p132813497181">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row11379194815185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="CreateGatewayResponseV2__p82834951819">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="CreateGatewayResponseV2__p1928124921812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="CreateGatewayResponseV2__p62819494180">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateGatewayResponseV2__p2281849151812"><strong id="CreateGatewayResponseV2__b82824915189">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__table1238114810186" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row193811348171810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="CreateGatewayResponseV2__p142884920188">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="CreateGatewayResponseV2__p8281449171811">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="CreateGatewayResponseV2__p628104921811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row1038134831811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="CreateGatewayResponseV2__p1428049161813">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="CreateGatewayResponseV2__p328194921816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="CreateGatewayResponseV2__p10282494188">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row2038164814188"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="CreateGatewayResponseV2__p82824915182">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="CreateGatewayResponseV2__p1028164911186">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="CreateGatewayResponseV2__p12814991812">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateGatewayResponseV2__p92834917181"><strong id="CreateGatewayResponseV2__b18281749191810">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__table13383848131814" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="CreateGatewayResponseV2__row1338394815182"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="CreateGatewayResponseV2__p22874918181">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="CreateGatewayResponseV2__p72834910181">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="CreateGatewayResponseV2__p12291649191813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row11383174811815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="CreateGatewayResponseV2__p19298494180">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="CreateGatewayResponseV2__p192914916184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="CreateGatewayResponseV2__p12924920182">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row938344814186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="CreateGatewayResponseV2__p11299494185">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="CreateGatewayResponseV2__p1429104918180">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="CreateGatewayResponseV2__p3291649181813">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section102915491181"><h4 class="sectiontitle">Example Requests</h4><p id="CreateGatewayResponseV2__p142994917188">Creating a response for an API group</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen19291849151814">{
|
|
"name" : "response_demo"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section1029194917188"><h4 class="sectiontitle">Example Responses</h4><p id="CreateGatewayResponseV2__p1029114910182"><strong id="CreateGatewayResponseV2__b1629114913183">Status code: 201</strong></p>
|
|
<p id="CreateGatewayResponseV2__p17291149121819">Created</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen132914494180">{
|
|
"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
|
|
},
|
|
"THIRD_AUTH_FAILURE" : {
|
|
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
|
|
"default" : true,
|
|
"status" : 401
|
|
},
|
|
"THIRD_AUTH_IDENTITIES_FAILURE" : {
|
|
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
|
|
"default" : true,
|
|
"status" : 401
|
|
},
|
|
"THIRD_AUTH_CONF_FAILURE" : {
|
|
"body" : "{\"error_code\":\"$context.error.code\",\"error_msg\":\"$context.error.message\",\"request_id\":\"$context.requestId\"}",
|
|
"default" : true,
|
|
"status" : 500
|
|
}
|
|
}
|
|
}</pre>
|
|
<p id="CreateGatewayResponseV2__p12312049111819"><strong id="CreateGatewayResponseV2__b143134941819">Status code: 400</strong></p>
|
|
<p id="CreateGatewayResponseV2__p15315490189">Bad Request</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen431174981810">{
|
|
"error_code" : "APIG.2011",
|
|
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="CreateGatewayResponseV2__p12311249161816"><strong id="CreateGatewayResponseV2__b3311649101816">Status code: 401</strong></p>
|
|
<p id="CreateGatewayResponseV2__p1431114912189">Unauthorized</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen173118496181">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="CreateGatewayResponseV2__p5311449121817"><strong id="CreateGatewayResponseV2__b73211499187">Status code: 403</strong></p>
|
|
<p id="CreateGatewayResponseV2__p6327496186">Forbidden</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen1132104920183">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="CreateGatewayResponseV2__p7321492187"><strong id="CreateGatewayResponseV2__b11321499189">Status code: 404</strong></p>
|
|
<p id="CreateGatewayResponseV2__p932849151817">Not Found</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen20323499183">{
|
|
"error_code" : "APIG.3001",
|
|
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
|
|
}</pre>
|
|
<p id="CreateGatewayResponseV2__p13264914189"><strong id="CreateGatewayResponseV2__b18321649141813">Status code: 500</strong></p>
|
|
<p id="CreateGatewayResponseV2__p332449131810">Internal Server Error</p>
|
|
<pre class="screen" id="CreateGatewayResponseV2__screen1332184917185">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section153215498185"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateGatewayResponseV2__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateGatewayResponseV2__row740513481186"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="CreateGatewayResponseV2__p132104913181">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="CreateGatewayResponseV2__p153244912180">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateGatewayResponseV2__row640574851811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateGatewayResponseV2__p2032134951820">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateGatewayResponseV2__p732144918181">Created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row11405194818182"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateGatewayResponseV2__p1332649111813">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateGatewayResponseV2__p5321349191819">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row12405134816186"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateGatewayResponseV2__p1932164913182">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateGatewayResponseV2__p103344931817">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row1840574841812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateGatewayResponseV2__p113314941813">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateGatewayResponseV2__p193314910188">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row10405124851813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateGatewayResponseV2__p1333849111820">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateGatewayResponseV2__p1533134917189">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateGatewayResponseV2__row8405848111810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="CreateGatewayResponseV2__p163320495181">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="CreateGatewayResponseV2__p83384919182">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateGatewayResponseV2__section163364915182"><h4 class="sectiontitle">Error Codes</h4><p id="CreateGatewayResponseV2__p033204920181">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>
|
|
|