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>
1837 lines
152 KiB
HTML
1837 lines
152 KiB
HTML
<a name="ShowDetailsOfApiV2_1"></a><a name="ShowDetailsOfApiV2_1"></a>
|
||
|
||
<h1 class="topictitle1">Querying API Details</h1>
|
||
<div id="body174917567224"><div class="section" id="ShowDetailsOfApiV2_1__section1049145602217"><h4 class="sectiontitle">Function</h4><p id="ShowDetailsOfApiV2_1__p19492556112213">This API is used to query the details of an API.</p>
|
||
</div>
|
||
<div class="section" id="ShowDetailsOfApiV2_1__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="ShowDetailsOfApiV2_1__p2049314567229">GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__table15494105692220" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row9493165617227"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowDetailsOfApiV2_1__p1649525612228">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowDetailsOfApiV2_1__p3495135613224">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowDetailsOfApiV2_1__p64955567221">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowDetailsOfApiV2_1__p12495145632218">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row1649415632215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfApiV2_1__p164961056142218">project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfApiV2_1__p94965567227">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfApiV2_1__p5496556122214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfApiV2_1__p549715617229">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="ShowDetailsOfApiV2_1__row6494105616221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfApiV2_1__p8497456192220">instance_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfApiV2_1__p94971756202215">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfApiV2_1__p124979568224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfApiV2_1__p149811562220">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row154941956172213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowDetailsOfApiV2_1__p1549835614226">api_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowDetailsOfApiV2_1__p74988562223">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowDetailsOfApiV2_1__p1749825616228">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowDetailsOfApiV2_1__p2049918568220">API ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ShowDetailsOfApiV2_1__section7499156102212"><h4 class="sectiontitle">Request Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1450011565227"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowDetailsOfApiV2_1__p175018569220">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowDetailsOfApiV2_1__p115011562225">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowDetailsOfApiV2_1__p1550214564224">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowDetailsOfApiV2_1__p5502195682215">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row1500155632211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowDetailsOfApiV2_1__p5502256122215">X-Auth-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowDetailsOfApiV2_1__p185031456152219">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowDetailsOfApiV2_1__p145038567221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowDetailsOfApiV2_1__p16503115616229">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="ShowDetailsOfApiV2_1__section10504145622214"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowDetailsOfApiV2_1__p155041956112219"><strong id="ShowDetailsOfApiV2_1__b3505105652215">Status code: 200</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row650695617228"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p351195610226">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p18511105614227">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p135122562223">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row165071956142215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p18512155652220">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p45123569224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p651285611225">API name.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p3513056142217">It can contain 3 to 255 characters, starting with a letter or digit. Only letters, digits, and these special characters are allowed: -_./:()</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row16507135613227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1151375642216">type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p45131956152214">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p115131556182211">API type.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul851413561223"><li id="ShowDetailsOfApiV2_1__li165149563227">1: public API</li><li id="ShowDetailsOfApiV2_1__li12514356172219">2: private API</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p1551435692214">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul14514125692214"><li id="ShowDetailsOfApiV2_1__li051455622217"><strong id="ShowDetailsOfApiV2_1__b3514656112210">1</strong></li><li id="ShowDetailsOfApiV2_1__li135151556152213"><strong id="ShowDetailsOfApiV2_1__b951511567223">2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row75075564226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p55157562229">version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p651595620224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p15515156162213">API version.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p3516195613221">Maximum: <strong id="ShowDetailsOfApiV2_1__b155169569221">16</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1550735613229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p951620565228">req_protocol</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p185161456172215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p951616561222">API request protocol:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul9517456122211"><li id="ShowDetailsOfApiV2_1__li14517105682213">HTTP</li><li id="ShowDetailsOfApiV2_1__li951714566224">HTTPS</li><li id="ShowDetailsOfApiV2_1__li15517115610225">BOTH: Both HTTP and HTTPS are supported.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p351845617225">Default: <strong id="ShowDetailsOfApiV2_1__b1351818565227">HTTPS</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p25181656192216">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul75181456142215"><li id="ShowDetailsOfApiV2_1__li851835618228"><strong id="ShowDetailsOfApiV2_1__b185191856142216">HTTP</strong></li><li id="ShowDetailsOfApiV2_1__li251965642215"><strong id="ShowDetailsOfApiV2_1__b851925642210">HTTPS</strong></li><li id="ShowDetailsOfApiV2_1__li10519656102214"><strong id="ShowDetailsOfApiV2_1__b151955612219">BOTH</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row18507125616225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p195201556142211">req_method</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p15203563229">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p115211562222">API request method.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1852195618223">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul9521856112220"><li id="ShowDetailsOfApiV2_1__li1452265610225"><strong id="ShowDetailsOfApiV2_1__b0522105610227">GET</strong></li><li id="ShowDetailsOfApiV2_1__li145221656152215"><strong id="ShowDetailsOfApiV2_1__b1652255611229">POST</strong></li><li id="ShowDetailsOfApiV2_1__li155222565228"><strong id="ShowDetailsOfApiV2_1__b1252345602214">PUT</strong></li><li id="ShowDetailsOfApiV2_1__li1952395613229"><strong id="ShowDetailsOfApiV2_1__b1152319562224">DELETE</strong></li><li id="ShowDetailsOfApiV2_1__li652314566227"><strong id="ShowDetailsOfApiV2_1__b352316569225">HEAD</strong></li><li id="ShowDetailsOfApiV2_1__li115237561225"><strong id="ShowDetailsOfApiV2_1__b10524556142220">PATCH</strong></li><li id="ShowDetailsOfApiV2_1__li6524056102212"><strong id="ShowDetailsOfApiV2_1__b1752475682212">OPTIONS</strong></li><li id="ShowDetailsOfApiV2_1__li1752495610229"><strong id="ShowDetailsOfApiV2_1__b12524195692217">ANY</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row3507125610225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p85257565222">req_uri</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p6525056122214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p5526155618225">Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.</p>
|
||
<div class="note" id="ShowDetailsOfApiV2_1__note1052610563225"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ShowDetailsOfApiV2_1__p95261556102217">The address must comply with the URI specifications.</p>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row25072056192213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1752745611221">auth_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p8527175619221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p852755618229">API authentication mode. Options:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul55281156112219"><li id="ShowDetailsOfApiV2_1__li352805611226">NONE</li><li id="ShowDetailsOfApiV2_1__li952815569228">APP</li><li id="ShowDetailsOfApiV2_1__li135281956132219">IAM</li><li id="ShowDetailsOfApiV2_1__li1252810565226">AUTHORIZER: custom authentication. When auth_type is set to AUTHORIZER, the authorizer_id field is mandatory.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p1252919562225">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul9529205620223"><li id="ShowDetailsOfApiV2_1__li2529145692220"><strong id="ShowDetailsOfApiV2_1__b19529165692215">NONE</strong></li><li id="ShowDetailsOfApiV2_1__li0529356142217"><strong id="ShowDetailsOfApiV2_1__b1152916564225">APP</strong></li><li id="ShowDetailsOfApiV2_1__li9529205632212"><strong id="ShowDetailsOfApiV2_1__b12530195610225">IAM</strong></li><li id="ShowDetailsOfApiV2_1__li125307565223"><strong id="ShowDetailsOfApiV2_1__b135307566222">AUTHORIZER</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1350735602210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p75309569228">auth_opt</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1253125611228"><a href="#ShowDetailsOfApiV2_1__response_AuthOpt">AuthOpt</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p153118569225">Security authentication parameter.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row95071356152216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p16532195612228">cors</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p6532155642210">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1753213569227">Indicates whether CORS is supported.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul2053210568222"><li id="ShowDetailsOfApiV2_1__li2053314564229">TRUE: supported</li><li id="ShowDetailsOfApiV2_1__li12533175612216">FALSE: not supported</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p1553318567224">Default: <strong id="ShowDetailsOfApiV2_1__b185331566227">false</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p10533556192214">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul165335568226"><li id="ShowDetailsOfApiV2_1__li65331356152212"><strong id="ShowDetailsOfApiV2_1__b19534556102213">true</strong></li><li id="ShowDetailsOfApiV2_1__li453425610226"><strong id="ShowDetailsOfApiV2_1__b6534135632215">false</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1150775619225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p185341456122216">match_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1553485612224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p153511566226">API matching mode:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1753595619220"><li id="ShowDetailsOfApiV2_1__li125351256192215">SWA: Prefix match</li><li id="ShowDetailsOfApiV2_1__li653512568224">NORMAL: Exact match Default value: NORMAL</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p853575620225">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul7535195617226"><li id="ShowDetailsOfApiV2_1__li15536125617226"><strong id="ShowDetailsOfApiV2_1__b35361556122219">SWA</strong></li><li id="ShowDetailsOfApiV2_1__li145361856162218"><strong id="ShowDetailsOfApiV2_1__b12536156112218">NORMAL</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row6507185672216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p10536656192213">backend_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p253665617224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p105372563221">Backend type. Options:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul7537165622214"><li id="ShowDetailsOfApiV2_1__li13537145615226">HTTP: web backend</li><li id="ShowDetailsOfApiV2_1__li13537185610223">FUNCTION: FunctionGraph backend. When backend_type is set to FUNCTION, the func_info field is mandatory.</li><li id="ShowDetailsOfApiV2_1__li9537135620223">MOCK: mock backend. When backend_type is set to MOCK, the mock_info field is mandatory.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p16538115642211">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1853805622214"><li id="ShowDetailsOfApiV2_1__li253845672213"><strong id="ShowDetailsOfApiV2_1__b1253885692218">HTTP</strong></li><li id="ShowDetailsOfApiV2_1__li19538185617226"><strong id="ShowDetailsOfApiV2_1__b2539456192211">FUNCTION</strong></li><li id="ShowDetailsOfApiV2_1__li195391756102214"><strong id="ShowDetailsOfApiV2_1__b7539356192211">MOCK</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1950795614227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p953910562226">remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p5540556132213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p3540456162211">API description. It cannot exceed 255 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row2508205602218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1754055611228">group_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p6541456132217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p115411456112214">ID of the API group to which the API belongs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row0508135616228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p55411456122216">body_remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p16541115611221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p85426562229">API request body, which can be an example request body, media type, or parameters. Ensure that the request body does not exceed 20,480 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row14508156102210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p18542356152220">result_normal_sample</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p125421256152218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p35421656112217">Example response for a successful request. Ensure that the response does not exceed 20,480 characters.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p6543115615225"></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row550845672214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1254305622214">result_failure_sample</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1654317562223">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p11543456152210">Example response for a failed request. Ensure that the response does not exceed 20,480 characters.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1454415611227"></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row65089569225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1854414562228">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p85441056112210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1544256132212">Custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row35086567221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p8545456132216">tags</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p195451756102217">Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p15456562228">Tag.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p9545195652216">Use letters, digits, and special characters (-*#%.:_) and start with a letter.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p17546756132217">By default, 10 tags are supported. To increase the quota, contact technical support to modify the API_TAG_NUM_LIMIT configuration.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p135467569226">Minimum: <strong id="ShowDetailsOfApiV2_1__b15461656122219">1</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p354615568229">Maximum: <strong id="ShowDetailsOfApiV2_1__b1054695616223">128</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row17508195617229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p754611568221">response_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p554745612220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p4547056132217">Group response ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row850812568228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p9548105612220">roma_app_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p135481565221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p125492056162211">Integration application ID.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p20549556182217">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1650845622211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p185498561224">domain_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1256495611221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p10565145615224">Custom domain name bound to the API.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1756545632211">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row2508165617227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p13565195682210">tag</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1156595622210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p156695615226">Tag.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p18566165632211">This field will be deprecated. You can use the tags field instead.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1550855642211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p356685632212">content_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p756645620226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p656705612228">Request content type:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul17567256142211"><li id="ShowDetailsOfApiV2_1__li2056717568223">application/json</li><li id="ShowDetailsOfApiV2_1__li1356719561225">application/xml</li><li id="ShowDetailsOfApiV2_1__li135671569221">multipart/form-data</li><li id="ShowDetailsOfApiV2_1__li5568135619222">text/plain</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p1656895642214">Coming soon.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p11568155622219">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul19568125642217"><li id="ShowDetailsOfApiV2_1__li19568155617227"><strong id="ShowDetailsOfApiV2_1__b1956885619227">application/json</strong></li><li id="ShowDetailsOfApiV2_1__li65681956102213"><strong id="ShowDetailsOfApiV2_1__b165691561228">application/xml</strong></li><li id="ShowDetailsOfApiV2_1__li1956915615222"><strong id="ShowDetailsOfApiV2_1__b1656985618226">multipart/form-data</strong></li><li id="ShowDetailsOfApiV2_1__li15569656102210"><strong id="ShowDetailsOfApiV2_1__b956915564224">text/plain</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row155081156202219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p15696565227">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p185692564228">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p257010564221">API ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row115091056112213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p257015620225">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p19570856202213">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p11571105672212">App status.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul4571135642217"><li id="ShowDetailsOfApiV2_1__li3571105616228">1: valid</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1509115619227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p25711456142216">arrange_necessary</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p95711565224">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1657275642216">Indicates whether to enable orchestration.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row11509175619229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1857215610224">register_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p239215593229">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p173921859122213">Time when the API is registered.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1050919563221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p20392165910222">update_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p183938593227">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p173932595225">Time when the API was last modified.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row105098568224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p173931459162220">group_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17393205982217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1239365917222">Name of the API group to which the API belongs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1550935612217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p93931159122212">group_version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p839315595226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p9393859142214">Version of the API group to which the API belongs.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p19393259132219">The default value is V1. Other versions are not supported.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p153931459142211">Default: <strong id="ShowDetailsOfApiV2_1__b15393259152213">V1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row10509756202219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1339325910221">run_env_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p19393115982218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p18394205992217">ID of the environment in which the API has been published.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p163948598227">Separate multiple environment IDs with vertical bars (|).</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row550945618223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p18394659172214">run_env_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1394959172217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p7394115910220">Name of the environment in which the API has been published.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p13394259162214">Separate multiple environment names with vertical bars (|).</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row17509135613226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p9394145917223">publish_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p203941859152213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p9394259182212">Publication record ID.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p6394145992213">Separate multiple publication record IDs with vertical bars (|).</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row12509135652212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p3394195952212">publish_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p739465912219">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1139475922220">Publication time.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1539465918221">Separate the time of multiple publication records with vertical bars (|).</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row85091256192213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p5395185902212">roma_app_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p439517594226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1139575919223">Name of the integration application to which the API belongs.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p7395135911222">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row55098564228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p639512596228">ld_api_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p193951459112214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1439513592224">ID of the corresponding custom backend API.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1539505917222">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1851085652212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p439510597224">backend_api</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1339595910225"><a href="#ShowDetailsOfApiV2_1__response_BackendApi">BackendApi</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p139555919223">Web backend details.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row17510656172220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p63955593223">api_group_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p739555918222"><a href="#ShowDetailsOfApiV2_1__response_ApiGroupCommonInfo">ApiGroupCommonInfo</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p2396259172215">API group information.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1151045614225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p183961459102212">func_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17396175942218"><a href="#ShowDetailsOfApiV2_1__response_ApiFunc">ApiFunc</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p143964597225">FunctionGraph backend details.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row145102056152215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p11396145992212">mock_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p039615918226"><a href="#ShowDetailsOfApiV2_1__response_ApiMock">ApiMock</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1239685914221">Mock backend details.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row16510105617222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1439615591223">req_params</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p039685972211">Array of <a href="#ShowDetailsOfApiV2_1__response_ReqParam">ReqParam</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p133961359192213">Request parameters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1651014564229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p739665942211">backend_params</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1039715942210">Array of <a href="#ShowDetailsOfApiV2_1__response_BackendParam">BackendParam</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p839719598226">Backend parameters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row13510125682213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1639785910221">policy_functions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p4397459112214">Array of <a href="#ShowDetailsOfApiV2_1__response_ApiPolicyFunctionResp">ApiPolicyFunctionResp</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1339765972212">FunctionGraph backend policies.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row151075642218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p339725932215">policy_mocks</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p239715590221">Array of <a href="#ShowDetailsOfApiV2_1__response_ApiPolicyMockResp">ApiPolicyMockResp</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1139735932213">Mock backend policies.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1251010561228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p17397175914227">policy_https</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1739765972210">Array of <a href="#ShowDetailsOfApiV2_1__response_ApiPolicyHttpResp">ApiPolicyHttpResp</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1839785942216">Web backend policies.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_AuthOpt"></a><a name="response_AuthOpt"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_AuthOpt" frame="border" border="1" rules="all"><caption><b>Table 4 </b>AuthOpt</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1658645692213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p163981159122220">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p1339885952210">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p139875972216">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row155861456122215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p13398259192216">app_code_auth_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p5398185912220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p7398105913228">Indicates whether AppCode authentication is enabled. This parameter is valid only if auth_type is set to App. The default value is DISABLE.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul10398185916224"><li id="ShowDetailsOfApiV2_1__li11398459132217">DISABLE: AppCode authentication is disabled.</li><li id="ShowDetailsOfApiV2_1__li1139895962210">HEADER: AppCode authentication is enabled and the AppCode is located in the header.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p19399195932214">Default: <strong id="ShowDetailsOfApiV2_1__b19399195992215">DISABLE</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p133993596223">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul539945952218"><li id="ShowDetailsOfApiV2_1__li639915598229"><strong id="ShowDetailsOfApiV2_1__b2399159192220">DISABLE</strong></li><li id="ShowDetailsOfApiV2_1__li19399155912228"><strong id="ShowDetailsOfApiV2_1__b5399259102216">HEADER</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_BackendApi"></a><a name="response_BackendApi"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_BackendApi" frame="border" border="1" rules="all"><caption><b>Table 5 </b>BackendApi</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row858905662210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p18400145982212">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p640095915222">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p0400195972212">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row45901956202210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p154001459142218">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p94001759122220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p740075915224">Custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row125901756192210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p6400115962219">url_domain</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p16400145916223">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p64001959182216">Backend service address.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p124001759182219">A backend service address consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1940185914226">Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1259017562228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1240135911229">req_protocol</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p19401259152215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p134011859142211">Request protocol.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p19401145962217">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul16401859182218"><li id="ShowDetailsOfApiV2_1__li14401175916221"><strong id="ShowDetailsOfApiV2_1__b740195915225">HTTP</strong></li><li id="ShowDetailsOfApiV2_1__li18401155962217"><strong id="ShowDetailsOfApiV2_1__b940195992219">HTTPS</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row859019565226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1140117593228">remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1940145919226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p34011596226">Description. It cannot exceed 255 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row115901056122215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p204021959192219">req_method</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p12402165918228">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p0402185922217">Request method.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p18402175917224">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1340225922216"><li id="ShowDetailsOfApiV2_1__li17402155915225"><strong id="ShowDetailsOfApiV2_1__b164021259102212">GET</strong></li><li id="ShowDetailsOfApiV2_1__li3402135915221"><strong id="ShowDetailsOfApiV2_1__b17402175911224">POST</strong></li><li id="ShowDetailsOfApiV2_1__li140295942210"><strong id="ShowDetailsOfApiV2_1__b1240216597228">PUT</strong></li><li id="ShowDetailsOfApiV2_1__li16402759172211"><strong id="ShowDetailsOfApiV2_1__b17402459182211">DELETE</strong></li><li id="ShowDetailsOfApiV2_1__li1740245952212"><strong id="ShowDetailsOfApiV2_1__b1640215598226">HEAD</strong></li><li id="ShowDetailsOfApiV2_1__li44032594226"><strong id="ShowDetailsOfApiV2_1__b1540312593227">PATCH</strong></li><li id="ShowDetailsOfApiV2_1__li174036595224"><strong id="ShowDetailsOfApiV2_1__b184032594223">OPTIONS</strong></li><li id="ShowDetailsOfApiV2_1__li940365972218"><strong id="ShowDetailsOfApiV2_1__b6403359132212">ANY</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row145901756172215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1440385992218">version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p24031159182215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p3403559132215">Web backend version, which can contain a maximum of 16 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row8591145618223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p10403959122217">req_uri</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p13403359102215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p17403115912217">Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1403115918222">Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
||
<div class="note" id="ShowDetailsOfApiV2_1__note1640411592223"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ShowDetailsOfApiV2_1__p9404659152215">The address must comply with the URI specifications.</p>
|
||
</div></div>
|
||
<p id="ShowDetailsOfApiV2_1__p74046598227"></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row459195617221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p164047599228">timeout</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p8404359132220">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p940495918221">Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p18404125919227">Unit: ms.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p17404185918227">Minimum: <strong id="ShowDetailsOfApiV2_1__b8404185992211">1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1559115562224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1140410591220">enable_client_ssl</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1740575962210">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p104057597227">Indicates whether to enable two-way authentication.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1459125611223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p640575915225">retry_count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p140555982210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p940518596220">Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p13405105932211">–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p74050599222">Default: <strong id="ShowDetailsOfApiV2_1__b154059598222">-1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row11591756132219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1140595982219">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p74061059152217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p164065596226">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row13591165652218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1240645992220">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p640617595228">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1740655916227">Backend service status.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul16406165922214"><li id="ShowDetailsOfApiV2_1__li13406175942213">1: valid</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row65914567226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1040612592229">register_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p2406185914226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p154061259102218">Registration time.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row15591456102211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p74063599225">update_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p124061659152211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p18406359142219">Update time.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1659235682211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p9407165932219">vpc_channel_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p154074594226"><a href="#ShowDetailsOfApiV2_1__response_VpcInfo">VpcInfo</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p14407145982218">VPC channel details. This parameter is required if vpc_channel_status is set to 1.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row135921256142211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p04071959132213">vpc_channel_status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p740765992217">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p6407175918226">Indicates whether to use a VPC channel.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul12407125912227"><li id="ShowDetailsOfApiV2_1__li1240711599229">1: A VPC channel is used.</li><li id="ShowDetailsOfApiV2_1__li5407359192218">2: No VPC channel is used.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ApiGroupCommonInfo"></a><a name="response_ApiGroupCommonInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiGroupCommonInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ApiGroupCommonInfo</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1607356162217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p24081959192213">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p640855914222">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p840885912216">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row260795622217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p10408145982214">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p2408185912220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p12408559152214">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5607135662216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p174081359202217">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p114084594222">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p04081759142219">API group name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row760725615227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p540817593229">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p164091859182219">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p13409115919222">Status.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul134091759192214"><li id="ShowDetailsOfApiV2_1__li6409859202217">1: valid</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p14091759152212">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1040914598220"><li id="ShowDetailsOfApiV2_1__li12409195972213"><strong id="ShowDetailsOfApiV2_1__b18409359142218">1</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row260715562222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p94091059202219">sl_domain</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p16409185915220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1040945962215">Subdomain name that APIG automatically allocates to the API group.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row760745642214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p154091359142215">register_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p24098591224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p6410205917222">Creation time.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row146071156192212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p641055910227">update_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1741095915220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p14410759132213">Last modification time.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1360712569228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p15410175942219">on_sell_status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p6410185917227">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p64101592225">Indicates whether the API group has been listed on KooGallery.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1141014595227"><li id="ShowDetailsOfApiV2_1__li741014591223">1: listed</li><li id="ShowDetailsOfApiV2_1__li84103591221">2: not listed</li><li id="ShowDetailsOfApiV2_1__li1141065942211">3: under review</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p19410759142210">Not supported currently.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row66086567228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p7411175982214">url_domains</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p641112591220">Array of <a href="#ShowDetailsOfApiV2_1__response_UrlDomain">UrlDomain</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p9411159172210">Independent domain names bound to the API group.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_UrlDomain"></a><a name="response_UrlDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_UrlDomain" frame="border" border="1" rules="all"><caption><b>Table 7 </b>UrlDomain</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row461665662217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p1411359122215">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p141115912219">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p16411115918220">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row861616562228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p16411105917225">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p13411165913226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1411105916223">Domain ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row8616256112217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1441285962215">domain</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p74121059192215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p6412859182215">Domain name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row16616155619220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p7412959112219">cname_status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p2412959152217">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p204128597229">CNAME resolution status of the domain name.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul164121259132212"><li id="ShowDetailsOfApiV2_1__li841285942218">1: not resolved</li><li id="ShowDetailsOfApiV2_1__li84121559152211">2: resolving</li><li id="ShowDetailsOfApiV2_1__li3412195982215">3: resolved</li><li id="ShowDetailsOfApiV2_1__li134121159112213">4: resolution failed</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row86161656192212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p441385916225">ssl_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p941311591223">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p241315902213">SSL certificate ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row4616165612214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1441315594224">ssl_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1941335919227">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p19413155982210">SSL certificate name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row36161556192218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p44138590227">min_ssl_version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p641325952220">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p341385972219">Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p241375914220">Default: <strong id="ShowDetailsOfApiV2_1__b1241345916224">TLSv1.1</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p8413125922216">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1141335917228"><li id="ShowDetailsOfApiV2_1__li19413175910222"><strong id="ShowDetailsOfApiV2_1__b441317591226">TLSv1.1</strong></li><li id="ShowDetailsOfApiV2_1__li16414859142217"><strong id="ShowDetailsOfApiV2_1__b114141659192218">TLSv1.2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row8616155682219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p3414135972215">verified_client_certificate_enabled</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p141418595229">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1341415593225">Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p24142059142217">Default: <strong id="ShowDetailsOfApiV2_1__b19414155917226">false</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row961775602218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1241465912213">is_has_trusted_root_ca</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17414459192220">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p2414459162213">Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p18414159202220">Default: <strong id="ShowDetailsOfApiV2_1__b6414105922217">false</strong></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ApiFunc"></a><a name="response_ApiFunc"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiFunc" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ApiFunc</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row062620568229"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p2415125918229">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p5415115962217">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p74151598229">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row1627356202214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p114151259162218">function_urn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p13415159112213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p194151599222">Function URN.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row9627756142215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1941535916223">remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p164151859182216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1641510599224">Description. It cannot exceed 255 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row19627155617228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1341555912213">invocation_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p20415359112215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p194151959142215">Invocation mode.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul134151459122219"><li id="ShowDetailsOfApiV2_1__li34151259172218">async: asynchronous</li><li id="ShowDetailsOfApiV2_1__li10416155915222">sync: synchronous</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p741614593228">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul7416175952213"><li id="ShowDetailsOfApiV2_1__li94161159152218"><strong id="ShowDetailsOfApiV2_1__b1941675912216">async</strong></li><li id="ShowDetailsOfApiV2_1__li20416195914224"><strong id="ShowDetailsOfApiV2_1__b14416659102212">sync</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row10627165612223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p194161359192211">network_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p11416175962211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p204161592229">Function network architecture.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul2416145920229"><li id="ShowDetailsOfApiV2_1__li15416359202211">V1: non-VPC</li><li id="ShowDetailsOfApiV2_1__li641735919226">V2: VPC</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p9417195910225">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1841715911229"><li id="ShowDetailsOfApiV2_1__li1417185911226"><strong id="ShowDetailsOfApiV2_1__b18417175913227">V1</strong></li><li id="ShowDetailsOfApiV2_1__li1241785912222"><strong id="ShowDetailsOfApiV2_1__b3417859132217">V2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row4627175613222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p541719598222">version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p441755916223">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p04179592225">Function version.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1541735912223">If both a function alias URN and version are passed, only the alias URN will be used.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p8417105913225">Maximum: <strong id="ShowDetailsOfApiV2_1__b18417185982215">64</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5627656162216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1641785914224">alias_urn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p7418659142217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p941845942214">Function alias URN.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1641817591228">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row3627165632216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p11418105942213">timeout</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p10418359102216">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p941855910224">Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p14182594226">Unit: ms.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p4418659192210">Minimum: <strong id="ShowDetailsOfApiV2_1__b84181559142216">1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row11627115612212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p74191859162220">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17419185952217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p641915592223">Backend custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row26271656162219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p7419185902212">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p34191659112210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p2419159172216">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1962715619224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1419125918228">register_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p13419175919229">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p194191659132213">Registration time.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5627185618223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p541915972215">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p16419175942216">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p194191459172214">Backend service status.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul241905911221"><li id="ShowDetailsOfApiV2_1__li12419259182212">1: valid</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row6628175620229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1042035972220">update_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p12420105922212">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1242065942219">Update time.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ApiMock"></a><a name="response_ApiMock"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiMock" frame="border" border="1" rules="all"><caption><b>Table 9 </b>ApiMock</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row14639165617222"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p17420185952212">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p4420135962215">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p104201759162220">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row106391156162213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p19420125912211">remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p642045911221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p34201596222">Description. It cannot exceed 255 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row8639175642216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p5421759112216">result_content</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p10421115932210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1242195912227">Response.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row46391356152216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p134211359132220">version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1742135972210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p204218598223">Function version. It cannot exceed 64 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row9640115619223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p4421459202216">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1642105912221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p17421165917227">Backend custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row166401156102216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p17421459132213">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p114211759192214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p114219596226">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row11640185652218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p442165912223">register_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p44211859122212">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p10422359192212">Registration time.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1664035617223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p642275932210">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p242285902217">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1542235915225">Backend service status.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul742212594220"><li id="ShowDetailsOfApiV2_1__li1142215912228">1: valid</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row14640156142214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1642210592224">update_time</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1442285915222">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p164221059102212">Update time.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ReqParam"></a><a name="response_ReqParam"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ReqParam" frame="border" border="1" rules="all"><caption><b>Table 10 </b>ReqParam</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row16649156182217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p1442245982212">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p14422145918220">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p184231592225">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row17649456162217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p2423115911222">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p14423115952218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1642315598224">Parameter name.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1242305972210">The parameter name can contain 1 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row56501256132213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p3423125932214">type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p204231359202215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p142395922215">Parameter type.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p5423859142217">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1442315917225"><li id="ShowDetailsOfApiV2_1__li1142305952219"><strong id="ShowDetailsOfApiV2_1__b114231759152214">STRING</strong></li><li id="ShowDetailsOfApiV2_1__li10423159102210"><strong id="ShowDetailsOfApiV2_1__b134231559152215">NUMBER</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row15650256132214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p64232591229">location</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p942485913224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p104241597225">Parameter location.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p17424165915227">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul2424175913221"><li id="ShowDetailsOfApiV2_1__li1542420596226"><strong id="ShowDetailsOfApiV2_1__b1742455952212">PATH</strong></li><li id="ShowDetailsOfApiV2_1__li4424155911222"><strong id="ShowDetailsOfApiV2_1__b242495914224">QUERY</strong></li><li id="ShowDetailsOfApiV2_1__li124249595222"><strong id="ShowDetailsOfApiV2_1__b1042411594222">HEADER</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row206501567226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p3424359182220">default_value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p34245598226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p64247599221">Default value.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row26507560227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p44245593226">sample_value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p442485914222">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1425155918223">Example value.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row46501256102213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p942517594229">required</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p7425659132217">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p204257595221">Indicates whether the parameter is required. 1: yes 2: no</p>
|
||
<p id="ShowDetailsOfApiV2_1__p24259592221">The value of this parameter is 1 if Location is set to PATH, and 2 if Location is set to another value.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p2042535920220">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul15425175902212"><li id="ShowDetailsOfApiV2_1__li1425125919228"><strong id="ShowDetailsOfApiV2_1__b342515972212">1</strong></li><li id="ShowDetailsOfApiV2_1__li20425859142216"><strong id="ShowDetailsOfApiV2_1__b542545914227">2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row15650656172210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p24251159112217">valid_enable</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p20425135942220">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p142535992220">Indicates whether validity check is enabled.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul2425145922212"><li id="ShowDetailsOfApiV2_1__li15425175917220">1: enabled</li><li id="ShowDetailsOfApiV2_1__li19426159112216">2: disabled</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p2426185942211">Default: <strong id="ShowDetailsOfApiV2_1__b84261259182211">2</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p942675912212">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul134261159192216"><li id="ShowDetailsOfApiV2_1__li1442675919220"><strong id="ShowDetailsOfApiV2_1__b34267597224">1</strong></li><li id="ShowDetailsOfApiV2_1__li342611591229"><strong id="ShowDetailsOfApiV2_1__b5426185952213">2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5650856132216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p242675911220">remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p194261559192211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p10426659192216">Description. It cannot exceed 255 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row20650175632213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p134268595229">enumerations</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p9426155915227">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p204275598224">Enumerated value.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5650656142218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p242735942213">min_num</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p10427759132217">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1427359202215">Minimum value.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p12427145972218">This parameter is valid when type is set to NUMBER.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row665065613227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1042745922210">max_num</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17427145962211">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1842785910224">Maximum value.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p8427105911228">This parameter is valid when type is set to NUMBER.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row18650155672218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p15427185932211">min_size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p5427159142214">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p114273599228">Minimum length.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p12427185992218">This parameter is valid when type is set to STRING.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5650205615228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p19428155932214">max_size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1342875910220">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1942825916221">Maximum length.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p042816599226">This parameter is valid when type is set to STRING.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row565125632211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p7428759142211">regular</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p16428175952210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p6428195912214">Regular expression validation rule.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p942815596224">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1965185672212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p10428159132218">json_schema</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p142819596227">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p14281859132218">JSON validation rule.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p194281859192214">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5651756102212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p642885913226">pass_through</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p114281259162211">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1428115911222">Indicates whether to transparently transfer the parameter. 1: yes 2: no</p>
|
||
<p id="ShowDetailsOfApiV2_1__p17429135912228">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul64291559182214"><li id="ShowDetailsOfApiV2_1__li11429195932213"><strong id="ShowDetailsOfApiV2_1__b8429115910224">1</strong></li><li id="ShowDetailsOfApiV2_1__li17429165972210"><strong id="ShowDetailsOfApiV2_1__b12429125902218">2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row565111566225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1542914594222">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p10429759182218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p64291059202215">Parameter ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ApiPolicyFunctionResp"></a><a name="response_ApiPolicyFunctionResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiPolicyFunctionResp" frame="border" border="1" rules="all"><caption><b>Table 11 </b>ApiPolicyFunctionResp</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row866925618226"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p2429175982218">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p342985917222">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p19430155912226">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row1867012561221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p164305591221">function_urn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p143014590228">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1430125962210">Function URN.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row3670756202213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p164301759132218">invocation_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17430559132216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p7430559112216">Invocation mode.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul84301159152216"><li id="ShowDetailsOfApiV2_1__li343025911222">async: asynchronous</li><li id="ShowDetailsOfApiV2_1__li11430185917221">sync: synchronous</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p3430145918223">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1043011599229"><li id="ShowDetailsOfApiV2_1__li543015919229"><strong id="ShowDetailsOfApiV2_1__b1443015598223">async</strong></li><li id="ShowDetailsOfApiV2_1__li1431105916225"><strong id="ShowDetailsOfApiV2_1__b143111592222">sync</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row14670105618221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p194312592223">network_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p2043120590225">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1143115913225">Function network architecture.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul6431559102215"><li id="ShowDetailsOfApiV2_1__li10431175932214">V1: non-VPC</li><li id="ShowDetailsOfApiV2_1__li443135916228">V2: VPC</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p19431959192211">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1943110593225"><li id="ShowDetailsOfApiV2_1__li74314595225"><strong id="ShowDetailsOfApiV2_1__b9431359192212">V1</strong></li><li id="ShowDetailsOfApiV2_1__li3431155962215"><strong id="ShowDetailsOfApiV2_1__b1543145912217">V2</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row16701356172211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p16432859122219">version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p643210597229">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p14432165912229">Function version.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p174321659112216">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p144321659112219">Maximum: <strong id="ShowDetailsOfApiV2_1__b1843210595224">64</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row267017567221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p13432195914225">alias_urn</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p16432359182214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p943220593223">Function alias URN.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p14321059182210">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row76703560229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p14321559112220">timeout</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p843285916226">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p84321596223">Timeout allowed for APIG to request the backend service. If the function network architecture is set to V1, the maximum timeout is 60,000. If the network architecture is set to V2, the maximum timeout is 600,000 and can be modified by using the gateway parameter backend_timeout.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p104321359162212">Unit: ms.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p9432125992218">Minimum: <strong id="ShowDetailsOfApiV2_1__b64329597228">1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1267015619224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1433115972219">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1143365992216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p743313593226">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row20670145672217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1843355918229">effect_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p7433059132214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p3433115972215">Effective mode of the backend policy.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul134339596228"><li id="ShowDetailsOfApiV2_1__li14433459102211">ALL: All conditions are met.</li><li id="ShowDetailsOfApiV2_1__li9433175914224">ANY: Any condition is met.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p2433559132213">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul34331459162210"><li id="ShowDetailsOfApiV2_1__li1843395917221"><strong id="ShowDetailsOfApiV2_1__b1243310592221">ALL</strong></li><li id="ShowDetailsOfApiV2_1__li14433155922211"><strong id="ShowDetailsOfApiV2_1__b243312593221">ANY</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row3670856182219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p5434125962214">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p04341959152218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1843445915227">Backend name, which must start with a letter and can contain letters, digits, and underscores (_).</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1434105914224">Minimum: <strong id="ShowDetailsOfApiV2_1__b14434359122219">3</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p8434145972210">Maximum: <strong id="ShowDetailsOfApiV2_1__b1443415972212">64</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row10671656192220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p20434195910223">backend_params</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p943455913229">Array of <a href="#ShowDetailsOfApiV2_1__response_BackendParam">BackendParam</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p134341559112215">Backend parameters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row467116564227"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p174340590221">conditions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p11434115972211">Array of <a href="#ShowDetailsOfApiV2_1__response_CoditionResp">CoditionResp</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1143435972211">Policy conditions.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row17671135619228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1143420590226">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p243585922210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p24351659152213">Backend custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ApiPolicyMockResp"></a><a name="response_ApiPolicyMockResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiPolicyMockResp" frame="border" border="1" rules="all"><caption><b>Table 12 </b>ApiPolicyMockResp</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1468375618222"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p17435205916225">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p64351659192210">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p943514594225">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row1568345672213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p143565920225">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1043519596221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p0435195919222">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1868315672215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p144351859112217">effect_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p10435125910226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p204352593226">Effective mode of the backend policy.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul14436185910224"><li id="ShowDetailsOfApiV2_1__li14361259132213">ALL: All conditions are met.</li><li id="ShowDetailsOfApiV2_1__li843613599221">ANY: Any condition is met.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p13436155912213">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul194361659142213"><li id="ShowDetailsOfApiV2_1__li164362593228"><strong id="ShowDetailsOfApiV2_1__b1643685913221">ALL</strong></li><li id="ShowDetailsOfApiV2_1__li443645982211"><strong id="ShowDetailsOfApiV2_1__b184361959142215">ANY</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row166831056202217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p84361359192218">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p24361059102216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p174364596227">Backend name, which must start with a letter and can contain letters, digits, and underscores (_).</p>
|
||
<p id="ShowDetailsOfApiV2_1__p19436115911225">Minimum: <strong id="ShowDetailsOfApiV2_1__b5436159172214">3</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p12437125912223">Maximum: <strong id="ShowDetailsOfApiV2_1__b144371359132219">64</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row2683656102213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p11437859102219">backend_params</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1643775902213">Array of <a href="#ShowDetailsOfApiV2_1__response_BackendParam">BackendParam</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p84375593225">Backend parameters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row368314562229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p143715972219">conditions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p154372059102214">Array of <a href="#ShowDetailsOfApiV2_1__response_CoditionResp">CoditionResp</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p15437105982210">Policy conditions.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1268395612229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1243716590229">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p943755916227">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1443713593225">Backend custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row15683175652218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p443715592223">result_content</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p143755942218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1243735962219">Response.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_ApiPolicyHttpResp"></a><a name="response_ApiPolicyHttpResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ApiPolicyHttpResp" frame="border" border="1" rules="all"><caption><b>Table 13 </b>ApiPolicyHttpResp</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row17691155672217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p24387594226">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p94384590224">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p114381559112212">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row1069245602214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1243835952214">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p643845972210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p11438205942213">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row106921856172216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p154381259152211">effect_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1343825942211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p9438205912219">Effective mode of the backend policy.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul64381959112213"><li id="ShowDetailsOfApiV2_1__li543815593225">ALL: All conditions are met.</li><li id="ShowDetailsOfApiV2_1__li8439125920223">ANY: Any condition is met.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p19439959152218">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul13439205912214"><li id="ShowDetailsOfApiV2_1__li5439175914226"><strong id="ShowDetailsOfApiV2_1__b134396595226">ALL</strong></li><li id="ShowDetailsOfApiV2_1__li54398593224"><strong id="ShowDetailsOfApiV2_1__b1343920594221">ANY</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row56921256162210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p64390592223">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p18439205916225">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p154398594229">Backend name, which must start with a letter and can contain letters, digits, and underscores (_).</p>
|
||
<p id="ShowDetailsOfApiV2_1__p18439259162211">Minimum: <strong id="ShowDetailsOfApiV2_1__b1743955952214">3</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p10439959122216">Maximum: <strong id="ShowDetailsOfApiV2_1__b18439165972214">64</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row14692175692216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p13440459182211">backend_params</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p134402059122213">Array of <a href="#ShowDetailsOfApiV2_1__response_BackendParam">BackendParam</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1440559152215">Backend parameters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row669213568225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p2440155918226">conditions</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p204401559152215">Array of <a href="#ShowDetailsOfApiV2_1__response_CoditionResp">CoditionResp</a> objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1844019592227">Policy conditions.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row269265615220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p84402059152219">authorizer_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p644035982216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p174401359112214">Backend custom authorizer ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row2692105611222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p6440195902212">url_domain</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p044035952218">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1544165911228">Endpoint of the policy backend.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p844185952219">An endpoint consists of a domain name or IP address and a port number, with not more than 255 characters. It must be in the format "Domain name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p10441185952212">Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row2069245642210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p844105962215">req_protocol</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1044125914224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p12441105952215">Request protocol. Options include HTTP, HTTPS.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p544135902212">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul114411595221"><li id="ShowDetailsOfApiV2_1__li144411559132213"><strong id="ShowDetailsOfApiV2_1__b8441205912215">HTTP</strong></li><li id="ShowDetailsOfApiV2_1__li2441155915227"><strong id="ShowDetailsOfApiV2_1__b1944175920226">HTTPS</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1869245642212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p18441959102215">req_method</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1144214597226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p7500173414188">Request method. Options include GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, and ANY.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p644205918229">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1044265912212"><li id="ShowDetailsOfApiV2_1__li6442359192218"><strong id="ShowDetailsOfApiV2_1__b15442155918223">GET</strong></li><li id="ShowDetailsOfApiV2_1__li1344245972210"><strong id="ShowDetailsOfApiV2_1__b164421959122219">POST</strong></li><li id="ShowDetailsOfApiV2_1__li1344275915223"><strong id="ShowDetailsOfApiV2_1__b17442185917224">PUT</strong></li><li id="ShowDetailsOfApiV2_1__li244265914224"><strong id="ShowDetailsOfApiV2_1__b1244255942215">DELETE</strong></li><li id="ShowDetailsOfApiV2_1__li1044225932219"><strong id="ShowDetailsOfApiV2_1__b18442559172219">HEAD</strong></li><li id="ShowDetailsOfApiV2_1__li544215920227"><strong id="ShowDetailsOfApiV2_1__b13442359192211">PATCH</strong></li><li id="ShowDetailsOfApiV2_1__li14421759192210"><strong id="ShowDetailsOfApiV2_1__b17443145992218">OPTIONS</strong></li><li id="ShowDetailsOfApiV2_1__li19443185913223"><strong id="ShowDetailsOfApiV2_1__b1443185919229">ANY</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row269265610222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p18443159122218">req_uri</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p17443859202213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1044395962219">Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p7443659192214">Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
||
<div class="note" id="ShowDetailsOfApiV2_1__note744312591229"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="ShowDetailsOfApiV2_1__p9443859172218">The address must comply with the URI specifications.</p>
|
||
</div></div>
|
||
<p id="ShowDetailsOfApiV2_1__p344355918227"></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1869385610223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p64432591221">timeout</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p344345962215">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1344313598222">Timeout allowed for APIG to request the backend service. You can set the maximum timeout using the backend_timeout configuration item. The maximum value is 600,000.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p13443175913226">Unit: ms.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p13444115942215">Minimum: <strong id="ShowDetailsOfApiV2_1__b15444145915222">1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5693165611222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1144425912214">retry_count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p944465922215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p2044495962211">Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p174441859172212">–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p14441659142219">Default: <strong id="ShowDetailsOfApiV2_1__b10444115922211">-1</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row4693125622213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1044475912217">vpc_channel_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p10444759182219"><a href="#ShowDetailsOfApiV2_1__response_VpcInfo">VpcInfo</a> object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1244416594229">VPC channel details. This parameter is required if vpc_channel_status is set to 1.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row26931756152219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1244485911229">vpc_channel_status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p124441659112219">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p844495913221">Indicates whether to use a VPC channel.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul17445859192217"><li id="ShowDetailsOfApiV2_1__li4445259172218">1: A VPC channel is used.</li><li id="ShowDetailsOfApiV2_1__li1244525982216">2: No VPC channel is used.</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_BackendParam"></a><a name="response_BackendParam"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_BackendParam" frame="border" border="1" rules="all"><caption><b>Table 14 </b>BackendParam</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1170875652217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p17445135992215">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p64451059202212">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.14.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p114451159122212">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row9708155618228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p13445559182215">origin</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p11445759162217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p944685914226">Parameter type.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul17446135982220"><li id="ShowDetailsOfApiV2_1__li5446175911221">REQUEST: backend parameter</li><li id="ShowDetailsOfApiV2_1__li94465593228">CONSTANT: constant parameter</li><li id="ShowDetailsOfApiV2_1__li104467591225">SYSTEM: system parameter</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p1344618590229">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul44461859132218"><li id="ShowDetailsOfApiV2_1__li7446165982213"><strong id="ShowDetailsOfApiV2_1__b6446175910224">REQUEST</strong></li><li id="ShowDetailsOfApiV2_1__li24461359152215"><strong id="ShowDetailsOfApiV2_1__b1444625919225">CONSTANT</strong></li><li id="ShowDetailsOfApiV2_1__li184468595223"><strong id="ShowDetailsOfApiV2_1__b15446165992216">SYSTEM</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row370816563224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p94461559162218">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p194471859112212">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p114477592229">Parameter name.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p15447125932217">The parameter name must start with a letter and can only contain letters, digits, hyphens (-), underscores (_), and periods (.).</p>
|
||
<p id="ShowDetailsOfApiV2_1__p134471559102219">Minimum: <strong id="ShowDetailsOfApiV2_1__b184471359132210">1</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p6447559192218">Maximum: <strong id="ShowDetailsOfApiV2_1__b1944735992212">32</strong></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1770835619225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p74471259122213">remark</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p204471597227">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p544719595221">Description, which can contain a maximum of 255 characters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row470945612219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p11447859162213">location</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p14447195916221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p17447135913227">Parameter location. The value can be PATH, QUERY, or HEADER.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1344745913221">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul544719594226"><li id="ShowDetailsOfApiV2_1__li74483599229"><strong id="ShowDetailsOfApiV2_1__b11448195942219">PATH</strong></li><li id="ShowDetailsOfApiV2_1__li13448459132210"><strong id="ShowDetailsOfApiV2_1__b18448759162212">QUERY</strong></li><li id="ShowDetailsOfApiV2_1__li0448359192217"><strong id="ShowDetailsOfApiV2_1__b2044825910228">HEADER</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5709456162211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p44481259102215">value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1544811596226">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p9448135917228">Parameter value, which can contain a maximum of 255 characters.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p16448145932215">If the origin type is REQUEST, the value of this parameter is the parameter name in req_params.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p344855918228">If the origin type is CONSTANT, the value is a constant.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1944895914225">If the origin type is SYSTEM, the value is a system parameter name. System parameters include gateway parameters, frontend authentication parameters, and backend authentication parameters. You can set the frontend or backend authentication parameters after enabling custom frontend or backend authentication.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1344815942211">The gateway parameters are as follows:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul644855912214"><li id="ShowDetailsOfApiV2_1__li10449059192210">$context.sourceIp: source IP address of the API caller.</li><li id="ShowDetailsOfApiV2_1__li15449165982215">$context.stage: deployment environment in which the API is called.</li><li id="ShowDetailsOfApiV2_1__li9449859182218">$context.apiId: API ID.</li><li id="ShowDetailsOfApiV2_1__li15449115972216">$context.appId: ID of the app used by the API caller.</li><li id="ShowDetailsOfApiV2_1__li944913596221">$context.requestId: request ID generated when the API is called.</li><li id="ShowDetailsOfApiV2_1__li744955982213">$context.serverAddr: address of the gateway server.</li><li id="ShowDetailsOfApiV2_1__li7449259162216">$context.serverName: name of the gateway server.</li><li id="ShowDetailsOfApiV2_1__li1444955920222">$context.handleTime: time when the API request is processed.</li><li id="ShowDetailsOfApiV2_1__li19449759152217">$context.providerAppId: ID of the app used by the API owner. This parameter is currently not supported.</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p1044925913228">Frontend authentication parameter: prefixed with "$context.authorizer.frontend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.frontend.aaa".</p>
|
||
<p id="ShowDetailsOfApiV2_1__p2045011595226">Backend authentication parameter: prefixed with "$context.authorizer.backend.". For example, to return "aaa" upon successful custom authentication, set this parameter to "$context.authorizer.backend.aaa".</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row670918564221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p114506592224">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1345035932215">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p145015590220">Parameter ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row197091656102213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p12450195912215">req_param_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p3450175952214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1345015910224">Request parameter ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_CoditionResp"></a><a name="response_CoditionResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_CoditionResp" frame="border" border="1" rules="all"><caption><b>Table 15 </b>CoditionResp</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row6721165617227"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p3450155992217">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p17450135962212">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p2450195932218">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row10721165692215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p24502599227">req_param_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p8451145992216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p845135952216">Input parameter name. This parameter is required if the policy type is param.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row9721456142218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1451185919227">condition_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p174511659172214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p44511459202216">Policy condition.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul1445185918225"><li id="ShowDetailsOfApiV2_1__li54518596223">exact: exact match</li><li id="ShowDetailsOfApiV2_1__li8451115916222">enum: enumeration</li><li id="ShowDetailsOfApiV2_1__li2045116596221">pattern: regular expression</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p14451195913223">This parameter is required if the policy type is param.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p24511598229">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul245115917226"><li id="ShowDetailsOfApiV2_1__li164511659142216"><strong id="ShowDetailsOfApiV2_1__b745215918225">exact</strong></li><li id="ShowDetailsOfApiV2_1__li3452145917225"><strong id="ShowDetailsOfApiV2_1__b54526597228">enum</strong></li><li id="ShowDetailsOfApiV2_1__li14452125972212"><strong id="ShowDetailsOfApiV2_1__b15452205915222">pattern</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row0721105613223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1745235952216">condition_origin</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p5452105922214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p154521659182212">Policy type.</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul184524595223"><li id="ShowDetailsOfApiV2_1__li144521459152215">param: input parameter</li><li id="ShowDetailsOfApiV2_1__li154521759102218">source: source IP address</li></ul>
|
||
<p id="ShowDetailsOfApiV2_1__p5452105916221">Enumeration values:</p>
|
||
<ul id="ShowDetailsOfApiV2_1__ul745219594227"><li id="ShowDetailsOfApiV2_1__li345275982217"><strong id="ShowDetailsOfApiV2_1__b11453165911222">param</strong></li><li id="ShowDetailsOfApiV2_1__li1645317599228"><strong id="ShowDetailsOfApiV2_1__b16453115982212">source</strong></li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row6722656102211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p6453135922215">condition_value</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p845315598229">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1245395912216">Condition value.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1372215563226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1345311591220">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p3453185992216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p645365942212">ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1722165611229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p24537595225">req_param_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p154532596222">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1045325922217">Input parameter ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row97223561220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p5453145912229">req_param_location</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p154531959152210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p10454175912219">Input parameter location.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="ShowDetailsOfApiV2_1__response_VpcInfo"></a><a name="response_VpcInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_VpcInfo" frame="border" border="1" rules="all"><caption><b>Table 16 </b>VpcInfo</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row14730115612226"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.16.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p1445495972214">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.16.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p124546596221">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.16.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p19454559132218">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row7730135652212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1945445952214">ecs_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p18454195922210">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p245445932213">Cloud server ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row12730135615223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p9454459132219">ecs_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p2454195912216">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p14549590227">Cloud server name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row5731105617220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1245415982217">cascade_flag</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p8455195915222">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p9455759152218">Indicates whether to use the cascading mode.</p>
|
||
<p id="ShowDetailsOfApiV2_1__p1845585911229">Currently, this parameter is not supported.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1673175614222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p54551859162218">vpc_channel_proxy_host</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p104558594224">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p045512593228">Proxy host.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row27311756152219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p2455155915222">vpc_channel_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p18455195982211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p134556596226">VPC channel ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row2731145652213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p18455195952219">vpc_channel_port</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p15455859172211">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1145545982216">VPC channel port.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="ShowDetailsOfApiV2_1__p1345635917227"><strong id="ShowDetailsOfApiV2_1__b14456459192212">Status code: 401</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 17 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1673615567223"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.18.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p18456115912222">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.18.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p16456135913225">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.18.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p10456155916227">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row4737105612216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p1445611593223">error_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1345665962214">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.18.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p164565595226">Error code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row11737195622213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p045765915222">error_msg</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p7457195916221">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.18.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p545795982210">Error message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="ShowDetailsOfApiV2_1__p745775982218"><strong id="ShowDetailsOfApiV2_1__b184571859162216">Status code: 403</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 18 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row7739856142215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.20.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p144571459182213">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.20.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p1945719595224">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.20.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p17457159162219">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row18740195614220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p11458959112216">error_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p94581598222">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.20.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1245885919221">Error code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row197401656192215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p114581159192210">error_msg</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p15458959102213">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.20.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1145835913228">Error message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="ShowDetailsOfApiV2_1__p14458195962220"><strong id="ShowDetailsOfApiV2_1__b24581759152218">Status code: 404</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 19 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row1574265692215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.22.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p19459959182215">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.22.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p645965913223">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.22.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p20459195918224">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row10742145614229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.22.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p24598590224">error_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.22.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p134594593223">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.22.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p1345917596223">Error code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row1674216561223"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.22.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p14459175912223">error_msg</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.22.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p1460459142217">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.22.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p14606598229">Error message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p id="ShowDetailsOfApiV2_1__p1746011596226"><strong id="ShowDetailsOfApiV2_1__b1346025912216">Status code: 500</strong></p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 20 </b>Response body parameters</caption><thead align="left"><tr id="ShowDetailsOfApiV2_1__row16745256192214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.24.2.4.1.1"><p id="ShowDetailsOfApiV2_1__p14460155915229">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.24.2.4.1.2"><p id="ShowDetailsOfApiV2_1__p54602595223">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.24.2.4.1.3"><p id="ShowDetailsOfApiV2_1__p1461659162215">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row137451556142216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.24.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p12461459182214">error_code</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.24.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p34611559142211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.24.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p84616592221">Error code.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row0745145612224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.24.2.4.1.1 "><p id="ShowDetailsOfApiV2_1__p646112599228">error_msg</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.24.2.4.1.2 "><p id="ShowDetailsOfApiV2_1__p3461259182219">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.24.2.4.1.3 "><p id="ShowDetailsOfApiV2_1__p146125915229">Error message.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ShowDetailsOfApiV2_1__section946115911229"><h4 class="sectiontitle">Example Requests</h4><p id="ShowDetailsOfApiV2_1__p1446195910223">None</p>
|
||
</div>
|
||
<div class="section" id="ShowDetailsOfApiV2_1__section204619591226"><h4 class="sectiontitle">Example Responses</h4><p id="ShowDetailsOfApiV2_1__p1546115592223"><strong id="ShowDetailsOfApiV2_1__b6461115972216">Status code: 200</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p1946285920227">OK</p>
|
||
<pre class="screen" id="ShowDetailsOfApiV2_1__screen946216599220">{
|
||
"id" : "5f918d104dc84480a75166ba99efff21",
|
||
"tags" : [ "webApi" ],
|
||
"arrange_necessary" : 2,
|
||
"backend_type" : "HTTP",
|
||
"auth_type" : "AUTHORIZER",
|
||
"auth_opt" : {
|
||
"app_code_auth_type" : "DISABLE"
|
||
},
|
||
"authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac",
|
||
"backend_api" : {
|
||
"update_time" : "2020-08-02T16:32:47.077029Z",
|
||
"vpc_channel_status" : 1,
|
||
"vpc_channel_info" : {
|
||
"vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59",
|
||
"vpc_channel_proxy_host" : "www.example.com"
|
||
},
|
||
"url_domain" : "56a7d7358e1b42459c9d730d65b14e59",
|
||
"req_protocol" : "HTTPS",
|
||
"id" : "1ce8fda3586d4371bd83c955df37e102",
|
||
"req_method" : "GET",
|
||
"register_time" : "2020-07-31T12:42:51Z",
|
||
"req_uri" : "/test/benchmark",
|
||
"timeout" : 5000,
|
||
"status" : 1,
|
||
"retry_count" : "-1"
|
||
},
|
||
"cors" : false,
|
||
"status" : 1,
|
||
"group_name" : "api_group_001",
|
||
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
|
||
"group_version" : "V1",
|
||
"match_mode" : "NORMAL",
|
||
"name" : "Api_http",
|
||
"req_protocol" : "HTTPS",
|
||
"req_method" : "GET",
|
||
"req_uri" : "/test/http",
|
||
"type" : 1,
|
||
"version" : "V0.0.1",
|
||
"result_normal_sample" : "Example success response",
|
||
"result_failure_sample" : "Example failure response",
|
||
"register_time" : "2020-07-31T12:42:51Z",
|
||
"update_time" : "2020-08-02T16:32:47.046289Z",
|
||
"remark" : "Web backend API",
|
||
"backend_params" : [ {
|
||
"name" : "X-CONSTANT-HEADER",
|
||
"value" : "demo",
|
||
"location" : "HEADER",
|
||
"origin" : "CONSTANT",
|
||
"remark" : "constant_demo",
|
||
"id" : "8cb2eba19e7a4423a4e835647a8b8d76"
|
||
}, {
|
||
"name" : "app-id",
|
||
"value" : "$context.appId",
|
||
"location" : "HEADER",
|
||
"origin" : "SYSTEM",
|
||
"remark" : "App ID of the API caller",
|
||
"id" : "216ddda836e74d528f364ff589d9dd21"
|
||
} ]
|
||
}</pre>
|
||
<p id="ShowDetailsOfApiV2_1__p7465105910229"><strong id="ShowDetailsOfApiV2_1__b146565942217">Status code: 401</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p846535992214">Unauthorized</p>
|
||
<pre class="screen" id="ShowDetailsOfApiV2_1__screen19465559142218">{
|
||
"error_code" : "APIG.1002",
|
||
"error_msg" : "Incorrect token or token resolution failed"
|
||
}</pre>
|
||
<p id="ShowDetailsOfApiV2_1__p1046555919225"><strong id="ShowDetailsOfApiV2_1__b1046575952213">Status code: 403</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p12465105922210">Forbidden</p>
|
||
<pre class="screen" id="ShowDetailsOfApiV2_1__screen174651159112218">{
|
||
"error_code" : "APIG.1005",
|
||
"error_msg" : "No permissions to request this method"
|
||
}</pre>
|
||
<p id="ShowDetailsOfApiV2_1__p846615593222"><strong id="ShowDetailsOfApiV2_1__b1046685992218">Status code: 404</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p146625915221">Not Found</p>
|
||
<pre class="screen" id="ShowDetailsOfApiV2_1__screen1466125942219">{
|
||
"error_code" : "APIG.3002",
|
||
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
|
||
}</pre>
|
||
<p id="ShowDetailsOfApiV2_1__p2466105919224"><strong id="ShowDetailsOfApiV2_1__b5466759102220">Status code: 500</strong></p>
|
||
<p id="ShowDetailsOfApiV2_1__p1466165916225">Internal Server Error</p>
|
||
<pre class="screen" id="ShowDetailsOfApiV2_1__screen11466359192210">{
|
||
"error_code" : "APIG.9999",
|
||
"error_msg" : "System error"
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="ShowDetailsOfApiV2_1__section6467195912211"><h4 class="sectiontitle">Status Codes</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowDetailsOfApiV2_1__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowDetailsOfApiV2_1__row127635564220"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowDetailsOfApiV2_1__p19467175912210">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowDetailsOfApiV2_1__p13467115915228">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="ShowDetailsOfApiV2_1__row117631056122210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfApiV2_1__p10467145916228">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfApiV2_1__p64671592228">OK</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row676355632210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfApiV2_1__p164671959172210">401</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfApiV2_1__p144676598223">Unauthorized</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row157636563220"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfApiV2_1__p10467165910223">403</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfApiV2_1__p446765915223">Forbidden</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row167631756162218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfApiV2_1__p13468165982220">404</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfApiV2_1__p64681059142215">Not Found</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="ShowDetailsOfApiV2_1__row6763165611228"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowDetailsOfApiV2_1__p846812590227">500</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowDetailsOfApiV2_1__p1946819599228">Internal Server Error</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="ShowDetailsOfApiV2_1__section54682059192210"><h4 class="sectiontitle">Error Codes</h4><p id="ShowDetailsOfApiV2_1__p104681159132214">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<div class="familylinks">
|
||
<div class="parentlink"><strong>Parent topic:</strong> <a href="ApiManagement_1.html">API Management</a></div>
|
||
</div>
|
||
</div>
|
||
|