forked from docs/doc-exports
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: chenjunjie <chenjunjie@huawei.com> Co-committed-by: chenjunjie <chenjunjie@huawei.com>
465 lines
30 KiB
HTML
465 lines
30 KiB
HTML
<a name="UpdateAppV2"></a><a name="UpdateAppV2"></a>
|
|
|
|
<h1 class="topictitle1">Modifying an App</h1>
|
|
<div id="body74069614318"><div class="section" id="UpdateAppV2__section104061361931"><h4 class="sectiontitle">Function</h4><p id="UpdateAppV2__p340617619318">This API is used to modify the information about an app. Only the name and remark parameters can be modified. If the function of customizing keys and secrets is enabled, app_key and app_secret can also be modified.</p>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateAppV2__p2040618615311">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="UpdateAppV2__p9407665310">PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__table64131561337" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateAppV2__row134097618318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateAppV2__p174138617317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateAppV2__p194131961313">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateAppV2__p0413561730">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateAppV2__p4414166132">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row1540926233"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateAppV2__p11414861135">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateAppV2__p204141661235">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateAppV2__p341411619311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateAppV2__p841411613320">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="UpdateAppV2__row24091261231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateAppV2__p10414761637">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateAppV2__p1741514620313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateAppV2__p14151161436">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateAppV2__p14151761832">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row5409261139"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateAppV2__p1341556934">app_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateAppV2__p4416261315">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateAppV2__p341606331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateAppV2__p64166612313">App ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__section141617619310"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateAppV2__row9416162037"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateAppV2__p94174619313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateAppV2__p2417136433">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateAppV2__p2041714614311">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateAppV2__p34183611311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row104171165310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateAppV2__p174181163314">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateAppV2__p34185616313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateAppV2__p8418196432">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateAppV2__p54181061314">User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__request_AppCreate" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateAppV2__row74191268316"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="UpdateAppV2__p14201615317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="UpdateAppV2__p164211615318">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="UpdateAppV2__p1421467320">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="UpdateAppV2__p04216618314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row164190619319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateAppV2__p16421106636">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateAppV2__p144211068318">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateAppV2__p74218618311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateAppV2__p124211267313">App name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row12419186932"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateAppV2__p7422176435">remark</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateAppV2__p84225614319">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateAppV2__p9422668315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateAppV2__p10422561232">App description. It cannot exceed 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row124205614315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateAppV2__p542211611319">app_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateAppV2__p1742310617313">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateAppV2__p184233620318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateAppV2__p842356132">AppKey, which can contain 8 to 200 characters, starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row114201561931"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateAppV2__p8423166634">app_secret</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateAppV2__p14423261832">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateAppV2__p84241465315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateAppV2__p1142412620312">Secret, which can contain 8 to 128 characters, starting with a letter or digit. Only letters, digits, and the following special characters are allowed: _-!@#$%</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__section04241168314"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateAppV2__p154244616311"><strong id="UpdateAppV2__b842413618319">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__response_AppInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateAppV2__row242918614311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="UpdateAppV2__p14431461335">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="UpdateAppV2__p64321764311">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="UpdateAppV2__p114329610310">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row144301961930"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p94322061035">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p2432261138">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p1343319615312">ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row14308610310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p84331961431">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p1843312615318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p143326239">Name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row17430186735"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p6433061532">remark</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p124341062318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p134341361036">Description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row54301562039"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p13434467318">creator</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p343456334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p243496933">Creator of the app.</p>
|
|
<ul id="UpdateAppV2__ul1043416619311"><li id="UpdateAppV2__li1843418618315">USER: The app is created by an API user.</li><li id="UpdateAppV2__li9435661938">MARKET: The app is allocated by KooGallery.</li></ul>
|
|
<p id="UpdateAppV2__p20435186335">The value MARKET is currently not supported.</p>
|
|
<p id="UpdateAppV2__p144355610316">Enumeration values:</p>
|
|
<ul id="UpdateAppV2__ul24351661534"><li id="UpdateAppV2__li17435146839"><strong id="UpdateAppV2__b1435861137">USER</strong></li><li id="UpdateAppV2__li13435961834"><strong id="UpdateAppV2__b1443516839">MARKET</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row7430106535"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p543696338">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p114362610313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p74361861832">Update time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row124306618312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p1543615617314">app_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p194361961735">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p1043615619320">AppKey.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row34301863317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p84361068315">app_secret</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p043611612320">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p1943719611314">AppSecret.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row2430162315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p1943776431">register_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p44374612318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p1343716831">Registration time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row34301366318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p44371161135">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p144381161937">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p54381266310">Status.</p>
|
|
<ul id="UpdateAppV2__ul14381261138"><li id="UpdateAppV2__li943818617311">1: valid</li></ul>
|
|
<p id="UpdateAppV2__p44381161733">Enumeration values:</p>
|
|
<ul id="UpdateAppV2__ul104382618312"><li id="UpdateAppV2__li1543846238"><strong id="UpdateAppV2__b16439261435">1</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row1343016534"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p64391360312">app_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p2440116638">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p15440461238">App type.</p>
|
|
<ul id="UpdateAppV2__ul3440761133"><li id="UpdateAppV2__li15440265313">apig: APIG app, which is not recommended.</li><li id="UpdateAppV2__li1344016831">roma: ROMA integration application.</li></ul>
|
|
<p id="UpdateAppV2__p64412061732">The default value is apig. Other types are not supported currently.</p>
|
|
<p id="UpdateAppV2__p13441463315">Enumeration values:</p>
|
|
<ul id="UpdateAppV2__ul1644113612314"><li id="UpdateAppV2__li9441267314"><strong id="UpdateAppV2__b11441146932">apig</strong></li><li id="UpdateAppV2__li044126738"><strong id="UpdateAppV2__b5442564319">roma</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row24301361831"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateAppV2__p114421966312">roma_app_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateAppV2__p4442765317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateAppV2__p1844212611310">ROMA application type.</p>
|
|
<ul id="UpdateAppV2__ul1944210616315"><li id="UpdateAppV2__li54421465316">subscription: subscription application</li><li id="UpdateAppV2__li244276136">integration: integration application</li></ul>
|
|
<p id="UpdateAppV2__p844214612316">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateAppV2__p184431268312"><strong id="UpdateAppV2__b11443163315">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateAppV2__row34431761233"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="UpdateAppV2__p64451761032">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="UpdateAppV2__p4445565317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="UpdateAppV2__p11445461335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row1044317619317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateAppV2__p34461661320">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateAppV2__p2044636832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateAppV2__p154467612310">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row4444106338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateAppV2__p2446961632">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateAppV2__p204461065312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateAppV2__p1944619614310">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateAppV2__p64471161335"><strong id="UpdateAppV2__b944717617316">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="UpdateAppV2__row54471961936"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="UpdateAppV2__p154494617313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="UpdateAppV2__p154491161336">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="UpdateAppV2__p7463569319">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row64481669314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateAppV2__p174631261316">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateAppV2__p0463569317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateAppV2__p14644619311">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row18448267318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateAppV2__p1646415617310">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateAppV2__p17464369319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateAppV2__p2464661037">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateAppV2__p174641964313"><strong id="UpdateAppV2__b24645615316">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="UpdateAppV2__row34659617318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="UpdateAppV2__p164661561331">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="UpdateAppV2__p946617612317">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="UpdateAppV2__p74661861134">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row846596533"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateAppV2__p12466146433">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateAppV2__p164661064311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateAppV2__p104671661631">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row1946556130"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateAppV2__p19467661031">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateAppV2__p7467861337">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateAppV2__p546715612317">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateAppV2__p174671861934"><strong id="UpdateAppV2__b184671561232">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="UpdateAppV2__row24671261931"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="UpdateAppV2__p194686617313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="UpdateAppV2__p14468669311">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="UpdateAppV2__p5468369311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row14671061338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateAppV2__p84681961734">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateAppV2__p6469461317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateAppV2__p1469362312">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row84681761231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateAppV2__p13469961636">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateAppV2__p0469168312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateAppV2__p1469164317">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateAppV2__p946919613314"><strong id="UpdateAppV2__b164691613320">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="UpdateAppV2__row74696615314"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="UpdateAppV2__p14704614319">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="UpdateAppV2__p16470863313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="UpdateAppV2__p24701663314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row54701661837"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="UpdateAppV2__p34701664315">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="UpdateAppV2__p9471762038">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="UpdateAppV2__p74710618310">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row647086034"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="UpdateAppV2__p164718615315">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="UpdateAppV2__p17471661431">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="UpdateAppV2__p84711618316">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__section17471106733"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateAppV2__p9471361935">Modifying an app</p>
|
|
<pre class="screen" id="UpdateAppV2__screen9472186137">{
|
|
"name" : "app_demo",
|
|
"remark" : "Demo app"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__section9472367315"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateAppV2__p15472176536"><strong id="UpdateAppV2__b84721368315">Status code: 200</strong></p>
|
|
<p id="UpdateAppV2__p15472361239">OK</p>
|
|
<pre class="screen" id="UpdateAppV2__screen17472061135">{
|
|
"creator" : "USER",
|
|
"update_time" : "2020-08-03T13:21:48.381148828Z",
|
|
"app_key" : "ee8f878c252747028f07eb116c2cd91b",
|
|
"name" : "app_demo",
|
|
"remark" : "Demo app",
|
|
"id" : "356de8eb7a8742168586e5daf5339965",
|
|
"app_secret" : "416************ab8",
|
|
"register_time" : "2020-08-03T13:09:13",
|
|
"status" : 1,
|
|
"app_type" : "apig"
|
|
}</pre>
|
|
<p id="UpdateAppV2__p847316232"><strong id="UpdateAppV2__b10473186736">Status code: 400</strong></p>
|
|
<p id="UpdateAppV2__p14731766319">Bad Request</p>
|
|
<pre class="screen" id="UpdateAppV2__screen1847318612313">{
|
|
"error_code" : "APIG.2012",
|
|
"error_msg" : "Invalid parameter value,parameterName:id. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="UpdateAppV2__p12822269316"><strong id="UpdateAppV2__b18221569310">Status code: 401</strong></p>
|
|
<p id="UpdateAppV2__p18221062315">Unauthorized</p>
|
|
<pre class="screen" id="UpdateAppV2__screen4822969311">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="UpdateAppV2__p1082211616317"><strong id="UpdateAppV2__b8822136632">Status code: 403</strong></p>
|
|
<p id="UpdateAppV2__p88229618311">Forbidden</p>
|
|
<pre class="screen" id="UpdateAppV2__screen20822186138">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="UpdateAppV2__p1182216536"><strong id="UpdateAppV2__b1182211610319">Status code: 404</strong></p>
|
|
<p id="UpdateAppV2__p118221468312">Not Found</p>
|
|
<pre class="screen" id="UpdateAppV2__screen1182246538">{
|
|
"error_code" : "APIG.3002",
|
|
"error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"
|
|
}</pre>
|
|
<p id="UpdateAppV2__p58221061430"><strong id="UpdateAppV2__b1282266834">Status code: 500</strong></p>
|
|
<p id="UpdateAppV2__p10822176537">Internal Server Error</p>
|
|
<pre class="screen" id="UpdateAppV2__screen1782216732">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__section118221461836"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateAppV2__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateAppV2__row747613615320"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateAppV2__p1482336934">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateAppV2__p1982376937">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateAppV2__row19476861339"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateAppV2__p78231466315">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateAppV2__p9823165310">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row204774619313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateAppV2__p6823186638">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateAppV2__p15823666310">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row64771061632"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateAppV2__p19823166539">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateAppV2__p1382386733">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row12477761838"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateAppV2__p1482314611320">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateAppV2__p178232619316">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row7477206339"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateAppV2__p1082312613312">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateAppV2__p1982313618312">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateAppV2__row104771467320"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateAppV2__p18231167319">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateAppV2__p08231761831">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateAppV2__section5823116434"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateAppV2__p78233619316">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="CredentialManagement.html">Credential Management</a></div>
|
|
</div>
|
|
</div>
|
|
|