forked from docs/doc-exports
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
577 lines
41 KiB
HTML
577 lines
41 KiB
HTML
<a name="UpdateApiGroupV2"></a><a name="UpdateApiGroupV2"></a>
|
|
|
|
<h1 class="topictitle1">Modifying an API Group</h1>
|
|
<div id="body56895228458"><div class="section" id="UpdateApiGroupV2__section368972216458"><h4 class="sectiontitle">Function</h4><p id="UpdateApiGroupV2__p186895224456">This API is used to modify the attributes of an API group. Only the name and remark attributes of an API group can be modified.</p>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateApiGroupV2__p106891022124517">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="UpdateApiGroupV2__p9690182274511">PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__table14691222164511" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row15690162214515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateApiGroupV2__p1691192217457">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateApiGroupV2__p206911522204518">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateApiGroupV2__p069192212455">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateApiGroupV2__p1769172254517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row19690822184514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateApiGroupV2__p18692182214459">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateApiGroupV2__p169242216457">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateApiGroupV2__p96924229454">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateApiGroupV2__p11692722164513">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="UpdateApiGroupV2__row1169022212451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateApiGroupV2__p1769292216459">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateApiGroupV2__p1369232213459">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateApiGroupV2__p11693102294515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateApiGroupV2__p5693122210456">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1069042254512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateApiGroupV2__p3693192218450">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateApiGroupV2__p56931222154517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateApiGroupV2__p469342219458">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateApiGroupV2__p146939220458">API group ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__section36931221450"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row11694192264512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateApiGroupV2__p36941022184518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateApiGroupV2__p13694182264510">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateApiGroupV2__p169522217451">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateApiGroupV2__p106951822144517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row12694142210457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateApiGroupV2__p1969512215456">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateApiGroupV2__p769522211456">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateApiGroupV2__p169522213452">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateApiGroupV2__p06962225456">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="UpdateApiGroupV2__request_ApiGroupBase" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row76966225452"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="UpdateApiGroupV2__p7696622204510">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="UpdateApiGroupV2__p169742264517">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="UpdateApiGroupV2__p76972225455">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="UpdateApiGroupV2__p7697132274517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row15696182220456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateApiGroupV2__p26972022134517">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateApiGroupV2__p12697422154511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateApiGroupV2__p146975227451">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateApiGroupV2__p6697622104519">API group name.</p>
|
|
<p id="UpdateApiGroupV2__p1369814229453">The value can contain 3 to 255 characters, including letters, digits, and special characters (-_./():). It must start with a letter or digit.</p>
|
|
<p id="UpdateApiGroupV2__p176981622124516">Minimum: <strong id="UpdateApiGroupV2__b176981222134518">3</strong></p>
|
|
<p id="UpdateApiGroupV2__p106987223458">Maximum: <strong id="UpdateApiGroupV2__b76981522164515">255</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row14696122264510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateApiGroupV2__p15698172214455">remark</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateApiGroupV2__p869852212459">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateApiGroupV2__p869812215452">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateApiGroupV2__p15699132213453">API group description.</p>
|
|
<p id="UpdateApiGroupV2__p15699922174511">Maximum: <strong id="UpdateApiGroupV2__b14699132244510">1000</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__section7699322144518"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateApiGroupV2__p1269952215455"><strong id="UpdateApiGroupV2__b2699192224510">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_ApiGroupInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row670072210455"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="UpdateApiGroupV2__p0702162211452">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="UpdateApiGroupV2__p3702102214450">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="UpdateApiGroupV2__p57021422124519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row1070042284515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p5702162217457">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p670272213456">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p1370217224458">ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row11700422174513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p197031122124511">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p370362214519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p1370312210455">API group name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row15700162274517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p137031222184517">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p1770312217458">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p3703102220453">Status.</p>
|
|
<ul id="UpdateApiGroupV2__ul0703132224514"><li id="UpdateApiGroupV2__li137031022124513">1: valid</li></ul>
|
|
<p id="UpdateApiGroupV2__p18704172284519">Enumeration values:</p>
|
|
<ul id="UpdateApiGroupV2__ul1170414224457"><li id="UpdateApiGroupV2__li187041422104519"><strong id="UpdateApiGroupV2__b15704422164512">1</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1170032210453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p11704192212450">sl_domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p11704122204519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p11704922134516">Subdomain name that APIG automatically allocates to the API group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row5700112294512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p6705172264517">register_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p27052220458">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p0705132264512">Creation time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row157001422154518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p15705172210457">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p11705222204510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p107065224453">Last modification time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1170032218458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p170642216455">on_sell_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p1570672294513">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p14706622104517">Indicates whether the API group has been listed on KooGallery.</p>
|
|
<ul id="UpdateApiGroupV2__ul5706112218451"><li id="UpdateApiGroupV2__li127061422124518">1: listed</li><li id="UpdateApiGroupV2__li10706142215456">2: not listed</li><li id="UpdateApiGroupV2__li17707182214514">3: under review</li></ul>
|
|
<p id="UpdateApiGroupV2__p670722219458">Not supported currently.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row5700172214457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p12707722194514">url_domains</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p370714225458">Array of <a href="#UpdateApiGroupV2__response_UrlDomain">UrlDomain</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p37077228456">Independent domain names bound to the API group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row14700422184518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p670819226458">sl_domain_access_enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p1070816222452">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p670812213455">Whether the debugging domain name is accessible. Options: true and false.</p>
|
|
<p id="UpdateApiGroupV2__p12708722174511">Default: <strong id="UpdateApiGroupV2__b870822264520">true</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row15701122204514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p137081922164518">sl_domains</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p167091322144519">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p8709182215452">Automatically allocated subdomain names.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row3701172217451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p07092022134514">remark</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p270915229450">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p1770922211456">Description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row157016226453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p1070915223453">call_limits</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p1971042216457">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p971022224514">Total number of times all APIs in the API group can be accessed. Consider the payload capacity of the backend service when setting this parameter. By default, there is no limit on the number of API calls.</p>
|
|
<p id="UpdateApiGroupV2__p771012215456">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1170182213456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p1971002294511">time_interval</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p20711162212455">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p67111022114520">Period of time for limiting the number of API calls.</p>
|
|
<p id="UpdateApiGroupV2__p87110224455">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row8701622144512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p37111322104511">time_unit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p0711322114519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p4711112224517">Time unit for limiting the number of API calls.</p>
|
|
<p id="UpdateApiGroupV2__p1271232274520">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1970120229459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p37129220450">is_default</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p16712102217457">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p20712522134519">Indicates whether the API group is the default group.</p>
|
|
<ul id="UpdateApiGroupV2__ul498252212458"><li id="UpdateApiGroupV2__li498216229456">1: Yes</li><li id="UpdateApiGroupV2__li16483851134914">2: No</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row370152234510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p17712182264515">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p9713112254519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p0713172284518">Group version.</p>
|
|
<ul id="UpdateApiGroupV2__ul19713142220456"><li id="UpdateApiGroupV2__li18713122220455">V1: global group</li><li id="UpdateApiGroupV2__li1771315223450">V2: application-level group</li></ul>
|
|
<p id="UpdateApiGroupV2__p271372213456">The default value is V1. This parameter is not supported currently.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row170162216452"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p11713192212459">roma_app_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p11713622154515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p187149229457">ID of the integration application to which the API group belongs.</p>
|
|
<p id="UpdateApiGroupV2__p27140229453">This parameter is required when the group version is V2.</p>
|
|
<p id="UpdateApiGroupV2__p3714192284511">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row5701132224514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateApiGroupV2__p971418221452">roma_app_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateApiGroupV2__p19714192211454">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateApiGroupV2__p4714152218459">Name of the integration application to which the API group belongs.</p>
|
|
<p id="UpdateApiGroupV2__p1671482204511">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="UpdateApiGroupV2__response_UrlDomain"></a><a name="response_UrlDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_UrlDomain" frame="border" border="1" rules="all"><caption><b>Table 5 </b>UrlDomain</caption><thead align="left"><tr id="UpdateApiGroupV2__row17715102217454"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="UpdateApiGroupV2__p5716102234510">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="UpdateApiGroupV2__p14716152294518">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="UpdateApiGroupV2__p171622244513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row10715102254513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p10717182213459">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p18717192244518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p1971722216451">Domain ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row13715122219455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p6717722124514">domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p107170225454">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p871722211458">Domain name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1971517221451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p177185226450">cname_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p17718182212453">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p67187224456">CNAME resolution status of the domain name.</p>
|
|
<ul id="UpdateApiGroupV2__ul6718822144519"><li id="UpdateApiGroupV2__li6718102264520">1: not resolved</li><li id="UpdateApiGroupV2__li207181822144511">2: resolving</li><li id="UpdateApiGroupV2__li6719102210457">3: resolved</li><li id="UpdateApiGroupV2__li12719722154517">4: resolution failed</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row13715122218457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p1971919224457">ssl_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p1871952264519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p12719162234511">SSL certificate ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1371542264517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p3719822164512">ssl_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p77191922104516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p872002274510">SSL certificate name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1171562214511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p1472092210454">min_ssl_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p472042204512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p137201422104518">Minimum SSL version. TLS 1.1 and TLS 1.2 are supported.</p>
|
|
<p id="UpdateApiGroupV2__p1372052216454">Default: <strong id="UpdateApiGroupV2__b11720222164512">TLSv1.1</strong></p>
|
|
<p id="UpdateApiGroupV2__p07207228459">Enumeration values:</p>
|
|
<ul id="UpdateApiGroupV2__ul972092212459"><li id="UpdateApiGroupV2__li15720142217453"><strong id="UpdateApiGroupV2__b872152234511">TLSv1.1</strong></li><li id="UpdateApiGroupV2__li13721222204512"><strong id="UpdateApiGroupV2__b97214223452">TLSv1.2</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row7716152204510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p7721122204517">verified_client_certificate_enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p772122211453">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p47212228458">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="UpdateApiGroupV2__p19721182210451">Default: <strong id="UpdateApiGroupV2__b1472182213452">false</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1171612227455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="UpdateApiGroupV2__p4721172216457">is_has_trusted_root_ca</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="UpdateApiGroupV2__p372292254518">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="UpdateApiGroupV2__p972215221454">Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.</p>
|
|
<p id="UpdateApiGroupV2__p772217225459">Default: <strong id="UpdateApiGroupV2__b16722192220455">false</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateApiGroupV2__p157221522204517"><strong id="UpdateApiGroupV2__b1172216224455">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row14722152212456"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="UpdateApiGroupV2__p57233225454">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="UpdateApiGroupV2__p167232222451">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="UpdateApiGroupV2__p13724162213452">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row6723142284512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpdateApiGroupV2__p9724152217457">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpdateApiGroupV2__p872442213454">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpdateApiGroupV2__p11724112218457">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1872313226453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="UpdateApiGroupV2__p072413221454">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="UpdateApiGroupV2__p5725122212455">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="UpdateApiGroupV2__p17251422194519">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateApiGroupV2__p172517228452"><strong id="UpdateApiGroupV2__b472542274515">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row1772510228455"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="UpdateApiGroupV2__p77268228452">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="UpdateApiGroupV2__p67262226459">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="UpdateApiGroupV2__p1372622294519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row3725162220455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="UpdateApiGroupV2__p147271122144515">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="UpdateApiGroupV2__p472762284518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="UpdateApiGroupV2__p2727152214454">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1472532264514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="UpdateApiGroupV2__p1772772211456">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="UpdateApiGroupV2__p107289228451">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="UpdateApiGroupV2__p072810229455">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateApiGroupV2__p1572816222457"><strong id="UpdateApiGroupV2__b57282223451">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row2728722194511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p id="UpdateApiGroupV2__p7729522114518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.2"><p id="UpdateApiGroupV2__p8729112210454">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.10.2.4.1.3"><p id="UpdateApiGroupV2__p8229152384514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row10728822194520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="UpdateApiGroupV2__p222992384513">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="UpdateApiGroupV2__p2022922318453">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="UpdateApiGroupV2__p19229182354510">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row1972822294516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="UpdateApiGroupV2__p7229112374513">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="UpdateApiGroupV2__p722912364515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="UpdateApiGroupV2__p7229152319453">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateApiGroupV2__p132308235458"><strong id="UpdateApiGroupV2__b02301023174510">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row9731162244516"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="UpdateApiGroupV2__p5230182316455">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p id="UpdateApiGroupV2__p323042314514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p id="UpdateApiGroupV2__p42306231457">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row137311322144513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="UpdateApiGroupV2__p11230142310457">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="UpdateApiGroupV2__p5230102364510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="UpdateApiGroupV2__p4230142316457">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row19732172210459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="UpdateApiGroupV2__p6230142314515">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="UpdateApiGroupV2__p8230112364519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="UpdateApiGroupV2__p6230823184517">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateApiGroupV2__p1723022324513"><strong id="UpdateApiGroupV2__b72301238457">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="UpdateApiGroupV2__row1573312214519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.1"><p id="UpdateApiGroupV2__p9230112319453">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.14.2.4.1.2"><p id="UpdateApiGroupV2__p1923011233459">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.14.2.4.1.3"><p id="UpdateApiGroupV2__p6230723174512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row1873362215454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="UpdateApiGroupV2__p112301423154511">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="UpdateApiGroupV2__p7230112384511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="UpdateApiGroupV2__p192300238458">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row19734132204510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.1 "><p id="UpdateApiGroupV2__p20231142311455">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.14.2.4.1.2 "><p id="UpdateApiGroupV2__p142314231453">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.14.2.4.1.3 "><p id="UpdateApiGroupV2__p10231182315452">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__section1023116238454"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateApiGroupV2__p5231102310459">Modifying an API group</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen15231192317453">{
|
|
"name" : "api_group_001",
|
|
"remark" : "API group 1"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__section1123110232454"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateApiGroupV2__p1523142312452"><strong id="UpdateApiGroupV2__b9231202316459">Status code: 200</strong></p>
|
|
<p id="UpdateApiGroupV2__p8231123184512">OK</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen132313234459">{
|
|
"update_time" : "2020-07-31T06:55:55Z.866474185Z",
|
|
"name" : "api_group_001",
|
|
"on_sell_status" : 2,
|
|
"remark" : "API group 1",
|
|
"sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
|
|
"sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
|
|
"id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
|
|
"register_time" : "2020-07-31T06:55:55Z",
|
|
"status" : 1,
|
|
"is_default" : 2,
|
|
"sl_domain_access_enabled" : true
|
|
}</pre>
|
|
<p id="UpdateApiGroupV2__p192311923204519"><strong id="UpdateApiGroupV2__b14231162311453">Status code: 400</strong></p>
|
|
<p id="UpdateApiGroupV2__p123142318451">Bad Request</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen6231423144515">{
|
|
"error_code" : "APIG.2012",
|
|
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="UpdateApiGroupV2__p1923122316453"><strong id="UpdateApiGroupV2__b15231723194511">Status code: 401</strong></p>
|
|
<p id="UpdateApiGroupV2__p16231102313453">Unauthorized</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen423112311457">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="UpdateApiGroupV2__p142321223184519"><strong id="UpdateApiGroupV2__b523222334512">Status code: 403</strong></p>
|
|
<p id="UpdateApiGroupV2__p1023218235456">Forbidden</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen7232102316458">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="UpdateApiGroupV2__p3232723194515"><strong id="UpdateApiGroupV2__b11232192313456">Status code: 404</strong></p>
|
|
<p id="UpdateApiGroupV2__p92327234451">Not Found</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen72325233457">{
|
|
"error_code" : "APIG.3001",
|
|
"error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
|
|
}</pre>
|
|
<p id="UpdateApiGroupV2__p123232344510"><strong id="UpdateApiGroupV2__b18232102324514">Status code: 500</strong></p>
|
|
<p id="UpdateApiGroupV2__p152329235455">Internal Server Error</p>
|
|
<pre class="screen" id="UpdateApiGroupV2__screen0232172317457">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__section323232315458"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateApiGroupV2__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateApiGroupV2__row13740172284518"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateApiGroupV2__p132321223164515">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateApiGroupV2__p62321523174520">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateApiGroupV2__row1074092224517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateApiGroupV2__p2023282324510">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateApiGroupV2__p823211232454">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row17740162264517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateApiGroupV2__p523252317451">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateApiGroupV2__p162321623124514">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row9740182214450"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateApiGroupV2__p3232142334518">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateApiGroupV2__p162329236451">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row8740522164517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateApiGroupV2__p1123212235456">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateApiGroupV2__p423232334511">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row167407227454"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateApiGroupV2__p2233192314515">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateApiGroupV2__p1423372354511">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateApiGroupV2__row87401322164519"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateApiGroupV2__p1223382394514">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateApiGroupV2__p1723302317453">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateApiGroupV2__section18233023114519"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateApiGroupV2__p122331223144516">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ApiGroupManagement.html">API Group Management</a></div>
|
|
</div>
|
|
</div>
|
|
|