Compare commits

...

19 Commits

Author SHA1 Message Date
2afc92113d Update Confpy for PDF 2024-11-15 08:29:15 +00:00
e881525766 mv APM to Application Services
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-11-13 09:31:03 +00:00
85562e1879 DWS UMN 831.100 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2024-11-13 08:55:54 +00:00
27de85471d SFS UMN DOC
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-11-12 10:42:24 +00:00
eb9f8a2617 CES UMN -20240202 version
Reviewed-by: Rumpler, Mihály <mihaly.rumpler@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2024-11-08 11:28:13 +00:00
591a41e089 LTS UMN 20240130 version.
Reviewed-by: Mützel, Andrea <andrea.muetzel@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-11-07 13:06:21 +00:00
bdd6c292a1 deh umn 20241022 version
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-11-07 11:58:20 +00:00
f50b1b1056 ddm_umn_20241105
Reviewed-by: Wagner, Fabian <fabian.wagner@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-11-07 08:38:08 +00:00
92e44874e7 OBS UMN DOC
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-11-06 14:33:05 +00:00
6c7c1c9d99 AntiDDoS API 20240914 version
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
2024-11-06 12:22:01 +00:00
e1710ee7e4 VPCEP API 20240912 version
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2024-11-06 11:17:39 +00:00
fa3fc5dfcf SFS UMN DOC
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-11-06 09:19:12 +00:00
7e1db74ac1 rds_umn_20241105
Reviewed-by: Székely, Ond <ond.szekely@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-11-06 08:28:14 +00:00
7d2a7ec198 OBS API DOC
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-11-05 16:37:11 +00:00
324aa7d3c4 APIG UMN 20240708 version
Reviewed-by: Mützel, Andrea <andrea.muetzel@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-11-05 15:25:06 +00:00
f3362c7fd1 re-introduce APIG API 20240125 version
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2024-11-05 13:07:40 +00:00
cab615fbec Revert "APIG API 20240125 version"
Reviewed-by: Topchii, Maria <mtopchii@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: vladimirvshivkov <vshivkovvladimir@gmail.com>
Co-committed-by: vladimirvshivkov <vshivkovvladimir@gmail.com>
2024-11-05 10:39:48 +00:00
ef0ada5a59 DWS DEV 20240716 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-11-02 09:07:47 +00:00
6aa966a79a ModelArts UMN 24.3.0 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lai, Weijian <laiweijian4@huawei.com>
Co-committed-by: Lai, Weijian <laiweijian4@huawei.com>
2024-11-02 09:04:52 +00:00
3916 changed files with 125926 additions and 99521 deletions

View File

@ -9,7 +9,7 @@
<div class="section" id="antiddos_02_0002__section51086148"><h4 class="sectiontitle">Request</h4><p id="antiddos_02_0002__p57231627073"><strong id="antiddos_02_0002__b175141502119">Request parameters</strong></p>
<p id="antiddos_02_0002__p19704119165617">None</p>
</div>
<div class="section" id="antiddos_02_0002__section57122151"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0002__ul36643426"><li id="antiddos_02_0002__li61355386">Parameter description
<div class="section" id="antiddos_02_0002__section57122151"><h4 class="sectiontitle">Response Messages</h4><ul id="antiddos_02_0002__ul36643426"><li id="antiddos_02_0002__li61355386">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0002__table15327568" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0002__row24486356"><th align="left" class="cellrowborder" valign="top" width="30.099999999999998%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0002__p37237828">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0002__p63474072">Type</p>
@ -75,32 +75,26 @@
</div>
</li></ul>
<ul id="antiddos_02_0002__ul549487"><li id="antiddos_02_0002__li4945391">Data structure description of <strong id="antiddos_02_0002__b121915511116">links</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0002__table44508523" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0002__row13604004"><th align="left" class="cellrowborder" valign="top" width="30.61%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="antiddos_02_0002__p28182506">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0002__table44508523" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0002__row13604004"><th align="left" class="cellrowborder" valign="top" width="37.34%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="antiddos_02_0002__p28182506">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.02%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="antiddos_02_0002__p1081649">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="25.540000000000003%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="antiddos_02_0002__p20504736">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.94%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="antiddos_02_0002__p20504736">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.43%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="antiddos_02_0002__p50270944">Description</p>
<th align="left" class="cellrowborder" valign="top" width="37.12%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="antiddos_02_0002__p50270944">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0002__row45414681"><td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0002__p54710514">href</p>
<tbody><tr id="antiddos_02_0002__row45414681"><td class="cellrowborder" valign="top" width="37.34%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0002__p54710514">href</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0002__p2366611">Yes</p>
<td class="cellrowborder" valign="top" width="25.540000000000003%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0002__p53636340152723">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0002__p53636340152723">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.43%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0002__p25189967">URLs of APIs</p>
<td class="cellrowborder" valign="top" width="37.12%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0002__p25189967">URLs of APIs</p>
</td>
</tr>
<tr id="antiddos_02_0002__row25383117"><td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0002__p42766607">rel</p>
<tr id="antiddos_02_0002__row25383117"><td class="cellrowborder" valign="top" width="37.34%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0002__p42766607">rel</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0002__p41543166">Yes</p>
<td class="cellrowborder" valign="top" width="25.540000000000003%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0002__p65381003152726">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0002__p65381003152726">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.43%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0002__p35618305">self</p>
<td class="cellrowborder" valign="top" width="37.12%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0002__p35618305">self</p>
</td>
</tr>
</tbody>

View File

@ -75,32 +75,26 @@
</div>
</li></ul>
<ul id="antiddos_02_0007__ul549487"><li id="antiddos_02_0007__li4945391">Data structure description of <strong id="antiddos_02_0007__b986916122420">links</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0007__table44508523" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0007__row13604004"><th align="left" class="cellrowborder" valign="top" width="30.61%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="antiddos_02_0007__p28182506">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0007__table44508523" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0007__row13604004"><th align="left" class="cellrowborder" valign="top" width="37.34%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="antiddos_02_0007__p28182506">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.02%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="antiddos_02_0007__p1081649">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="25.540000000000003%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="antiddos_02_0007__p20504736">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.94%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="antiddos_02_0007__p20504736">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.43%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="antiddos_02_0007__p50270944">Description</p>
<th align="left" class="cellrowborder" valign="top" width="37.12%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="antiddos_02_0007__p50270944">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0007__row45414681"><td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0007__p54710514">href</p>
<tbody><tr id="antiddos_02_0007__row45414681"><td class="cellrowborder" valign="top" width="37.34%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0007__p54710514">href</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0007__p2366611">Yes</p>
<td class="cellrowborder" valign="top" width="25.540000000000003%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0007__p53636340152723">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0007__p53636340152723">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.43%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0007__p25189967">URL of the API</p>
<td class="cellrowborder" valign="top" width="37.12%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0007__p25189967">URL of the API</p>
</td>
</tr>
<tr id="antiddos_02_0007__row25383117"><td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0007__p42766607">rel</p>
<tr id="antiddos_02_0007__row25383117"><td class="cellrowborder" valign="top" width="37.34%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0007__p42766607">rel</p>
</td>
<td class="cellrowborder" valign="top" width="18.02%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0007__p41543166">Yes</p>
<td class="cellrowborder" valign="top" width="25.540000000000003%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0007__p65381003152726">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.94%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0007__p65381003152726">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.43%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0007__p35618305">self</p>
<td class="cellrowborder" valign="top" width="37.12%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0007__p35618305">self</p>
</td>
</tr>
</tbody>

File diff suppressed because it is too large Load Diff

View File

@ -42,59 +42,47 @@
<p id="antiddos_02_0020__p132721814194018">None</p>
</div>
<div class="section" id="antiddos_02_0020__section62747764"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0020__table32841884" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="antiddos_02_0020__row64992155"><th align="left" class="cellrowborder" valign="top" width="30.44%" id="mcps1.3.4.2.2.5.1.1"><p id="antiddos_02_0020__p29873218">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0020__table32841884" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="antiddos_02_0020__row64992155"><th align="left" class="cellrowborder" valign="top" width="36.89%" id="mcps1.3.4.2.2.4.1.1"><p id="antiddos_02_0020__p29873218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.4.2.2.5.1.2"><p id="antiddos_02_0020__p3811622">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="17.299999999999997%" id="mcps1.3.4.2.2.4.1.2"><p id="antiddos_02_0020__p40305966">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.54%" id="mcps1.3.4.2.2.5.1.3"><p id="antiddos_02_0020__p40305966">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.54%" id="mcps1.3.4.2.2.5.1.4"><p id="antiddos_02_0020__p43557827">Description</p>
<th align="left" class="cellrowborder" valign="top" width="45.81%" id="mcps1.3.4.2.2.4.1.3"><p id="antiddos_02_0020__p43557827">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0020__row38523084"><td class="cellrowborder" valign="top" width="30.44%" headers="mcps1.3.4.2.2.5.1.1 "><p id="antiddos_02_0020__p33362098">enable_L7</p>
<tbody><tr id="antiddos_02_0020__row38523084"><td class="cellrowborder" valign="top" width="36.89%" headers="mcps1.3.4.2.2.4.1.1 "><p id="antiddos_02_0020__p33362098">enable_L7</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.4.2.2.5.1.2 "><p id="antiddos_02_0020__p17975388">Yes</p>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.4.2.2.4.1.2 "><p id="antiddos_02_0020__p46720306">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.4.2.2.5.1.3 "><p id="antiddos_02_0020__p46720306">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="35.54%" headers="mcps1.3.4.2.2.5.1.4 "><p id="antiddos_02_0020__p26248478">Whether L7 defense has been enabled.</p>
<td class="cellrowborder" valign="top" width="45.81%" headers="mcps1.3.4.2.2.4.1.3 "><p id="antiddos_02_0020__p26248478">Whether L7 defense has been enabled.</p>
</td>
</tr>
<tr id="antiddos_02_0020__row34909710"><td class="cellrowborder" valign="top" width="30.44%" headers="mcps1.3.4.2.2.5.1.1 "><p id="antiddos_02_0020__p9114291">traffic_pos_id</p>
<tr id="antiddos_02_0020__row34909710"><td class="cellrowborder" valign="top" width="36.89%" headers="mcps1.3.4.2.2.4.1.1 "><p id="antiddos_02_0020__p9114291">traffic_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.4.2.2.5.1.2 "><p id="antiddos_02_0020__p60129">Yes</p>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.4.2.2.4.1.2 "><p id="antiddos_02_0020__p3079683015913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.4.2.2.5.1.3 "><p id="antiddos_02_0020__p3079683015913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="35.54%" headers="mcps1.3.4.2.2.5.1.4 "><p id="antiddos_02_0020__p58963189">Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.</p>
<td class="cellrowborder" valign="top" width="45.81%" headers="mcps1.3.4.2.2.4.1.3 "><p id="antiddos_02_0020__p58963189">Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.</p>
</td>
</tr>
<tr id="antiddos_02_0020__row60906657"><td class="cellrowborder" valign="top" width="30.44%" headers="mcps1.3.4.2.2.5.1.1 "><p id="antiddos_02_0020__p34492175">http_request_pos_id</p>
<tr id="antiddos_02_0020__row60906657"><td class="cellrowborder" valign="top" width="36.89%" headers="mcps1.3.4.2.2.4.1.1 "><p id="antiddos_02_0020__p34492175">http_request_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.4.2.2.5.1.2 "><p id="antiddos_02_0020__p42402794">Yes</p>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.4.2.2.4.1.2 "><p id="antiddos_02_0020__p6409858615917">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.4.2.2.5.1.3 "><p id="antiddos_02_0020__p6409858615917">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="35.54%" headers="mcps1.3.4.2.2.5.1.4 "><p id="antiddos_02_0020__p38491397">Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.</p>
<td class="cellrowborder" valign="top" width="45.81%" headers="mcps1.3.4.2.2.4.1.3 "><p id="antiddos_02_0020__p38491397">Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.</p>
</td>
</tr>
<tr id="antiddos_02_0020__row10878253"><td class="cellrowborder" valign="top" width="30.44%" headers="mcps1.3.4.2.2.5.1.1 "><p id="antiddos_02_0020__p8723262">cleaning_access_pos_id</p>
<tr id="antiddos_02_0020__row10878253"><td class="cellrowborder" valign="top" width="36.89%" headers="mcps1.3.4.2.2.4.1.1 "><p id="antiddos_02_0020__p8723262">cleaning_access_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.4.2.2.5.1.2 "><p id="antiddos_02_0020__p35495616">Yes</p>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.4.2.2.4.1.2 "><p id="antiddos_02_0020__p1175927815921">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.4.2.2.5.1.3 "><p id="antiddos_02_0020__p1175927815921">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="35.54%" headers="mcps1.3.4.2.2.5.1.4 "><p id="antiddos_02_0020__p18980661">Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.</p>
<td class="cellrowborder" valign="top" width="45.81%" headers="mcps1.3.4.2.2.4.1.3 "><p id="antiddos_02_0020__p18980661">Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.</p>
</td>
</tr>
<tr id="antiddos_02_0020__row36608226"><td class="cellrowborder" valign="top" width="30.44%" headers="mcps1.3.4.2.2.5.1.1 "><p id="antiddos_02_0020__p12476353">app_type_id</p>
<tr id="antiddos_02_0020__row36608226"><td class="cellrowborder" valign="top" width="36.89%" headers="mcps1.3.4.2.2.4.1.1 "><p id="antiddos_02_0020__p12476353">app_type_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.4.2.2.5.1.2 "><p id="antiddos_02_0020__p3951668">Yes</p>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.4.2.2.4.1.2 "><p id="antiddos_02_0020__p4577985515925">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.4.2.2.5.1.3 "><p id="antiddos_02_0020__p4577985515925">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="35.54%" headers="mcps1.3.4.2.2.5.1.4 "><div class="p" id="antiddos_02_0020__p5423486315930">Application type ID. Possible values:<ul id="antiddos_02_0020__ul3859304915932"><li id="antiddos_02_0020__li247061915932">0</li><li id="antiddos_02_0020__li3331034115936">1</li></ul>
<td class="cellrowborder" valign="top" width="45.81%" headers="mcps1.3.4.2.2.4.1.3 "><div class="p" id="antiddos_02_0020__p5423486315930">Application type ID. Possible values:<ul id="antiddos_02_0020__ul3859304915932"><li id="antiddos_02_0020__li247061915932">0</li><li id="antiddos_02_0020__li3331034115936">1</li></ul>
</div>
</td>
</tr>

View File

@ -113,54 +113,72 @@
</div>
</li></ul>
<ul id="antiddos_02_0023__ul15263883"><li id="antiddos_02_0023__li3157226">Data structure description of <strong id="antiddos_02_0023__b84235270695528">ddosStatus</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0023__table28415039" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0023__row52787457"><th align="left" class="cellrowborder" valign="top" width="25.52%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="antiddos_02_0023__p47925604">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0023__table28415039" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0023__row52787457"><th align="left" class="cellrowborder" valign="top" width="31.726827317268274%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="antiddos_02_0023__p47925604">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.55%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="antiddos_02_0023__p56768687">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="16.238376162383762%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="antiddos_02_0023__p34860939">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.93%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="antiddos_02_0023__p34860939">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="antiddos_02_0023__p5163807">Description</p>
<th align="left" class="cellrowborder" valign="top" width="52.03479652034796%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="antiddos_02_0023__p5163807">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0023__row15615252"><td class="cellrowborder" valign="top" width="25.52%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0023__p56875922">floating_ip_address</p>
<tbody><tr id="antiddos_02_0023__row15615252"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p56875922">floating_ip_address</p>
</td>
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0023__p43546944">Yes</p>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p37641542">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.93%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0023__p37641542">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0023__p29066061">Floating IP address</p>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p29066061">Floating IP address</p>
</td>
</tr>
<tr id="antiddos_02_0023__row60267960"><td class="cellrowborder" valign="top" width="25.52%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0023__p49866595">floating_ip_id</p>
<tr id="antiddos_02_0023__row60267960"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p49866595">floating_ip_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0023__p12662370">Yes</p>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p19019038">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.93%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0023__p19019038">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0023__p64147070">ID of an EIP</p>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p64147070">ID of an EIP</p>
</td>
</tr>
<tr id="antiddos_02_0023__row2739500019464"><td class="cellrowborder" valign="top" width="25.52%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0023__p1650312719469">network_type</p>
<tr id="antiddos_02_0023__row2739500019464"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p1650312719469">network_type</p>
</td>
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0023__p6168491719469">Yes</p>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p3042242019469">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.93%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0023__p3042242019469">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0023__p4829698819469">EIP type. The value can be:</p>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p4829698819469">EIP type. The value can be:</p>
<ul id="antiddos_02_0023__ul3201971019469"><li id="antiddos_02_0023__li1974194019469"><strong id="antiddos_02_0023__b842352706163129">EIP</strong>: EIP that is bound or not bound with ECS.</li><li id="antiddos_02_0023__li4345973319469"><strong id="antiddos_02_0023__b842352706163134">ELB</strong>: EIP that is bound with ELB.</li></ul>
</td>
</tr>
<tr id="antiddos_02_0023__row40452719"><td class="cellrowborder" valign="top" width="25.52%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0023__p55444801">status</p>
<tr id="antiddos_02_0023__row40452719"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p55444801">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0023__p61843883">Yes</p>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p43298646">String</p>
</td>
<td class="cellrowborder" valign="top" width="10.93%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0023__p43298646">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><div class="p" id="antiddos_02_0023__p17529450">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0023__ul23547322"><li id="antiddos_02_0023__li10599309"><span class="parmvalue" id="antiddos_02_0023__parmvalue647133713"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0023__li28284925"><span class="parmvalue" id="antiddos_02_0023__parmvalue49183799"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0023__li53237738"><span class="parmvalue" id="antiddos_02_0023__parmvalue1489331450"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0023__li9377597"><span class="parmvalue" id="antiddos_02_0023__parmvalue1733807175"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0023__li17289511"><span class="parmvalue" id="antiddos_02_0023__parmvalue1993424236"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><div class="p" id="antiddos_02_0023__p17529450">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0023__ul23547322"><li id="antiddos_02_0023__li10599309"><span class="parmvalue" id="antiddos_02_0023__parmvalue1908468398"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0023__li28284925"><span class="parmvalue" id="antiddos_02_0023__parmvalue2100351451"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0023__li53237738"><span class="parmvalue" id="antiddos_02_0023__parmvalue181241444"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0023__li9377597"><span class="parmvalue" id="antiddos_02_0023__parmvalue1190858183"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0023__li17289511"><span class="parmvalue" id="antiddos_02_0023__parmvalue1630240370"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
</div>
</td>
</tr>
<tr id="antiddos_02_0023__row3236519104211"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p1746242474312">blackhole_endtime</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p14462202417433">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p1046292444316">End time of a black hole</p>
</td>
</tr>
<tr id="antiddos_02_0023__row125261128164217"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p0462524144318">protect_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p1462024134314">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p174621024154318">Protection type</p>
</td>
</tr>
<tr id="antiddos_02_0023__row25655269423"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p15462152414433">traffic_threshold</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p3462424174314">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p1846242424315">Traffic threshold</p>
</td>
</tr>
<tr id="antiddos_02_0023__row132361622104218"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p18462112464313">http_threshold</p>
</td>
<td class="cellrowborder" valign="top" width="16.238376162383762%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0023__p146219247438">Long</p>
</td>
<td class="cellrowborder" valign="top" width="52.03479652034796%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0023__p646212414311">HTTP traffic threshold</p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@ -42,23 +42,19 @@
<p id="antiddos_02_0024__p14332041145213">None</p>
</div>
<div class="section" id="antiddos_02_0024__section37841036"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0024__ul58618290"><li id="antiddos_02_0024__li57802569">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0024__table50461073" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0024__row8925963"><th align="left" class="cellrowborder" valign="top" width="19.830000000000002%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="antiddos_02_0024__p51914417">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0024__table50461073" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0024__row8925963"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0024__p51914417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.369999999999997%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="antiddos_02_0024__p44318255">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="19.84%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0024__p33008942">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="antiddos_02_0024__p33008942">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="antiddos_02_0024__p56478678">Description</p>
<th align="left" class="cellrowborder" valign="top" width="56.93%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="antiddos_02_0024__p56478678">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0024__row11370190"><td class="cellrowborder" valign="top" width="19.830000000000002%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="antiddos_02_0024__p48570174">status</p>
<tbody><tr id="antiddos_02_0024__row11370190"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0024__p48570174">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.369999999999997%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="antiddos_02_0024__p41870031">Yes</p>
<td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0024__p36029352">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="antiddos_02_0024__p36029352">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><div class="p" id="antiddos_02_0024__p32696434">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0024__ul25832457"><li id="antiddos_02_0024__li31165525"><span class="parmvalue" id="antiddos_02_0024__parmvalue555125744114325"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0024__li12054271"><span class="parmvalue" id="antiddos_02_0024__parmvalue404664094114337"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0024__li41379576"><span class="parmvalue" id="antiddos_02_0024__parmvalue600552156114412"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0024__li36871865"><span class="parmvalue" id="antiddos_02_0024__parmvalue1506354986114925"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0024__li63411331"><span class="parmvalue" id="antiddos_02_0024__parmvalue1400332350143613"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
<td class="cellrowborder" valign="top" width="56.93%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><div class="p" id="antiddos_02_0024__p32696434">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0024__ul25832457"><li id="antiddos_02_0024__li31165525"><span class="parmvalue" id="antiddos_02_0024__parmvalue555125744114325"><b>normal</b></span>: indicates that the defense status is normal.</li><li id="antiddos_02_0024__li12054271"><span class="parmvalue" id="antiddos_02_0024__parmvalue404664094114337"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0024__li41379576"><span class="parmvalue" id="antiddos_02_0024__parmvalue600552156114412"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0024__li36871865"><span class="parmvalue" id="antiddos_02_0024__parmvalue1506354986114925"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0024__li63411331"><span class="parmvalue" id="antiddos_02_0024__parmvalue1400332350143613"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
</div>
</td>
</tr>

File diff suppressed because it is too large Load Diff

View File

@ -114,69 +114,55 @@
</div>
</li></ul>
<ul id="antiddos_02_0026__ul65449295"><li id="antiddos_02_0026__li52172744">Data structure description of <strong id="antiddos_02_0026__b84235270695528">logs</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0026__table66901514" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0026__row55903933"><th align="left" class="cellrowborder" valign="top" width="25.16%" id="mcps1.3.4.3.1.2.1.5.1.1"><p id="antiddos_02_0026__p31924758">Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0026__table66901514" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0026__row55903933"><th align="left" class="cellrowborder" valign="top" width="29.79%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="antiddos_02_0026__p31924758">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.09%" id="mcps1.3.4.3.1.2.1.5.1.2"><p id="antiddos_02_0026__p35768611">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="28.560000000000002%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="antiddos_02_0026__p11576397">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.37%" id="mcps1.3.4.3.1.2.1.5.1.3"><p id="antiddos_02_0026__p11576397">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.38%" id="mcps1.3.4.3.1.2.1.5.1.4"><p id="antiddos_02_0026__p65272955">Description</p>
<th align="left" class="cellrowborder" valign="top" width="41.65%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="antiddos_02_0026__p65272955">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0026__row52618006"><td class="cellrowborder" valign="top" width="25.16%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0026__p34200069">start_time</p>
<tbody><tr id="antiddos_02_0026__row52618006"><td class="cellrowborder" valign="top" width="29.79%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0026__p34200069">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0026__p18742193">Yes</p>
<td class="cellrowborder" valign="top" width="28.560000000000002%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0026__p41722625">Long integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.37%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0026__p41722625">Long integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0026__p24089437">Start time</p>
<td class="cellrowborder" valign="top" width="41.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0026__p24089437">Start time</p>
</td>
</tr>
<tr id="antiddos_02_0026__row15478348"><td class="cellrowborder" valign="top" width="25.16%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0026__p45786662">end_time</p>
<tr id="antiddos_02_0026__row15478348"><td class="cellrowborder" valign="top" width="29.79%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0026__p45786662">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0026__p17732161">Yes</p>
<td class="cellrowborder" valign="top" width="28.560000000000002%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0026__p27018949">Long integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.37%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0026__p27018949">Long integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0026__p41051224">End time</p>
<td class="cellrowborder" valign="top" width="41.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0026__p41051224">End time</p>
</td>
</tr>
<tr id="antiddos_02_0026__row33916704"><td class="cellrowborder" valign="top" width="25.16%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0026__p62898512">status</p>
<tr id="antiddos_02_0026__row33916704"><td class="cellrowborder" valign="top" width="29.79%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0026__p62898512">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0026__p61614692">Yes</p>
<td class="cellrowborder" valign="top" width="28.560000000000002%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0026__p44557253152337">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.37%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0026__p44557253152337">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><div class="p" id="antiddos_02_0026__p57309018">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0026__ul46019115"><li id="antiddos_02_0026__li11518859"><span class="parmvalue" id="antiddos_02_0026__parmvalue1506354986114925"><b>1</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0026__li36560874"><span class="parmvalue" id="antiddos_02_0026__parmvalue1400332350143613"><b>2</b></span>: indicates that traffic is discarded.</li></ul>
<td class="cellrowborder" valign="top" width="41.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><div class="p" id="antiddos_02_0026__p57309018">Defense status, the possible value of which is one of the following:<ul id="antiddos_02_0026__ul46019115"><li id="antiddos_02_0026__li11518859"><span class="parmvalue" id="antiddos_02_0026__parmvalue1506354986114925"><b>1</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0026__li36560874"><span class="parmvalue" id="antiddos_02_0026__parmvalue1400332350143613"><b>2</b></span>: indicates that traffic is discarded.</li></ul>
</div>
</td>
</tr>
<tr id="antiddos_02_0026__row60612418"><td class="cellrowborder" valign="top" width="25.16%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0026__p10658788">trigger_bps</p>
<tr id="antiddos_02_0026__row60612418"><td class="cellrowborder" valign="top" width="29.79%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0026__p10658788">trigger_bps</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0026__p58055515">Yes</p>
<td class="cellrowborder" valign="top" width="28.560000000000002%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0026__p15266258152342">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.37%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0026__p15266258152342">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0026__p59436263">Traffic at the triggering point</p>
<td class="cellrowborder" valign="top" width="41.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0026__p59436263">Traffic at the triggering point</p>
</td>
</tr>
<tr id="antiddos_02_0026__row65164324"><td class="cellrowborder" valign="top" width="25.16%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0026__p43818926">trigger_pps</p>
<tr id="antiddos_02_0026__row65164324"><td class="cellrowborder" valign="top" width="29.79%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0026__p43818926">trigger_pps</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0026__p59672145">Yes</p>
<td class="cellrowborder" valign="top" width="28.560000000000002%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0026__p57307436152346">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.37%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0026__p57307436152346">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0026__p62941183">Packet rate at the triggering point</p>
<td class="cellrowborder" valign="top" width="41.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0026__p62941183">Packet rate at the triggering point</p>
</td>
</tr>
<tr id="antiddos_02_0026__row29599739"><td class="cellrowborder" valign="top" width="25.16%" headers="mcps1.3.4.3.1.2.1.5.1.1 "><p id="antiddos_02_0026__p48768695">trigger_http_pps</p>
<tr id="antiddos_02_0026__row29599739"><td class="cellrowborder" valign="top" width="29.79%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0026__p48768695">trigger_http_pps</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.4.3.1.2.1.5.1.2 "><p id="antiddos_02_0026__p57950190">Yes</p>
<td class="cellrowborder" valign="top" width="28.560000000000002%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0026__p51299491152351">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.37%" headers="mcps1.3.4.3.1.2.1.5.1.3 "><p id="antiddos_02_0026__p51299491152351">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.4.3.1.2.1.5.1.4 "><p id="antiddos_02_0026__p39486963">HTTP request rate at the triggering point</p>
<td class="cellrowborder" valign="top" width="41.65%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0026__p39486963">HTTP request rate at the triggering point</p>
</td>
</tr>
</tbody>

File diff suppressed because it is too large Load Diff

View File

@ -2,13 +2,18 @@
<h1 class="topictitle1">Change History</h1>
<div id="body1477278042389">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0034__table63136454111444" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0034__en-us_topic_0040422987_row2942532716410"><th align="left" class="cellrowborder" valign="top" width="27.33%" id="mcps1.3.1.1.3.1.1"><p id="antiddos_02_0034__en-us_topic_0040422987_p5627845516410"><strong id="antiddos_02_0034__b539069458">Release Date</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0034__table63136454111444" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0034__en-us_topic_0040422987_row2942532716410"><th align="left" class="cellrowborder" valign="top" width="27.33%" id="mcps1.3.1.1.3.1.1"><p id="antiddos_02_0034__en-us_topic_0040422987_p5627845516410"><strong id="antiddos_02_0034__b856695530">Release Date</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72.67%" id="mcps1.3.1.1.3.1.2"><p id="antiddos_02_0034__en-us_topic_0040422987_p2382284816410"><strong id="antiddos_02_0034__en-us_topic_0040422987_b3316380216410">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0034__row181611243749"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p121611143845">2024-03-29</p>
<tbody><tr id="antiddos_02_0034__row1842237134719"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p4422279474">2024-09-13</p>
</td>
<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p1742247154713">Updated the response parameters for <span class="filepath" id="antiddos_02_0034__filepath1395414468474"><b>Querying the list of defense statuses of EIPs</b></span>.</p>
</td>
</tr>
<tr id="antiddos_02_0034__row181611243749"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p121611143845">2024-03-29</p>
</td>
<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul184731533860"><li id="antiddos_02_0034__li5473103315618">Optimized the response parameters in section "Querying Alarm Configuration Information".</li><li id="antiddos_02_0034__li455816351565">Added an example response in section "Updating Alarm Configuration Information".</li></ul>
</td>

View File

@ -32,60 +32,48 @@
<div class="section" id="antiddos_02_0037__section33629549"><h4 class="sectiontitle">Request</h4><p id="antiddos_02_0037__p9930243125715"><strong id="antiddos_02_0037__b0200202219318">Request parameters</strong></p>
<p id="antiddos_02_0037__p1590674655719">None</p>
</div>
<div class="section" id="antiddos_02_0037__section34230492"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0037__ul48654403"><li id="antiddos_02_0037__li35236445">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0037__table48692557" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0037__row57013647"><th align="left" class="cellrowborder" valign="top" width="23.66%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="antiddos_02_0037__p54702703">Parameter</p>
<div class="section" id="antiddos_02_0037__section34230492"><h4 class="sectiontitle">Response Messages</h4><ul id="antiddos_02_0037__ul48654403"><li id="antiddos_02_0037__li35236445">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0037__table48692557" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0037__row57013647"><th align="left" class="cellrowborder" valign="top" width="30.84%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0037__p54702703">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.28%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="antiddos_02_0037__p1733939">Mandatory</p>
<th align="left" class="cellrowborder" valign="top" width="29.110000000000003%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0037__p6231364">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.33%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="antiddos_02_0037__p6231364">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.73%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="antiddos_02_0037__p34978441">Description</p>
<th align="left" class="cellrowborder" valign="top" width="40.050000000000004%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="antiddos_02_0037__p34978441">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0037__row14681450"><td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="antiddos_02_0037__p48346833">enable_L7</p>
<tbody><tr id="antiddos_02_0037__row14681450"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0037__p48346833">enable_L7</p>
</td>
<td class="cellrowborder" valign="top" width="23.28%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="antiddos_02_0037__p23779363">Yes</p>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0037__p47080266">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="22.33%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="antiddos_02_0037__p47080266">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="30.73%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="antiddos_02_0037__p28885026">Whether to enable layer-7 protection.</p>
<td class="cellrowborder" valign="top" width="40.050000000000004%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0037__p28885026">Whether to enable layer-7 protection.</p>
</td>
</tr>
<tr id="antiddos_02_0037__row58638646"><td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="antiddos_02_0037__p52109899">traffic_pos_id</p>
<tr id="antiddos_02_0037__row58638646"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0037__p52109899">traffic_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.28%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="antiddos_02_0037__p60152276">Yes</p>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0037__p40496186">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="22.33%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="antiddos_02_0037__p40496186">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.73%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="antiddos_02_0037__p58965604">Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.</p>
<td class="cellrowborder" valign="top" width="40.050000000000004%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0037__p58965604">Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.</p>
</td>
</tr>
<tr id="antiddos_02_0037__row60928390"><td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="antiddos_02_0037__p36252562">http_request_pos_id</p>
<tr id="antiddos_02_0037__row60928390"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0037__p36252562">http_request_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.28%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="antiddos_02_0037__p50776406">Yes</p>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0037__p19248251">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="22.33%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="antiddos_02_0037__p19248251">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.73%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="antiddos_02_0037__p56757654">Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.</p>
<td class="cellrowborder" valign="top" width="40.050000000000004%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0037__p56757654">Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.</p>
</td>
</tr>
<tr id="antiddos_02_0037__row3262153532716"><td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="antiddos_02_0037__p16262335182711">cleaning_access_pos_id</p>
<tr id="antiddos_02_0037__row3262153532716"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0037__p16262335182711">cleaning_access_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.28%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="antiddos_02_0037__p13262935172711">Yes</p>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0037__p3262535152711">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="22.33%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="antiddos_02_0037__p3262535152711">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.73%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="antiddos_02_0037__p15422169">Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.</p>
<td class="cellrowborder" valign="top" width="40.050000000000004%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0037__p15422169">Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.</p>
</td>
</tr>
<tr id="antiddos_02_0037__row145501038152720"><td class="cellrowborder" valign="top" width="23.66%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="antiddos_02_0037__p15550238192718">app_type_id</p>
<tr id="antiddos_02_0037__row145501038152720"><td class="cellrowborder" valign="top" width="30.84%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0037__p15550238192718">app_type_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.28%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="antiddos_02_0037__p18550438122716">Yes</p>
<td class="cellrowborder" valign="top" width="29.110000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0037__p13550438182713">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="22.33%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="antiddos_02_0037__p13550438182713">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="30.73%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><div class="p" id="antiddos_02_0037__p2630238915650">Application type ID. Possible values:<ul id="antiddos_02_0037__ul2584619815657"><li id="antiddos_02_0037__li4894818415657">0</li><li id="antiddos_02_0037__li546197471571">1</li></ul>
<td class="cellrowborder" valign="top" width="40.050000000000004%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><div class="p" id="antiddos_02_0037__p2630238915650">Application type ID. Possible values:<ul id="antiddos_02_0037__ul2584619815657"><li id="antiddos_02_0037__li4894818415657">0</li><li id="antiddos_02_0037__li546197471571">1</li></ul>
</div>
</td>
</tr>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,21 +0,0 @@
<a name="apic-ug-190430104"></a><a name="apic-ug-190430104"></a>
<h1 class="topictitle1">Custom Authorizers</h1>
<div id="body1567734680308"><p id="apic-ug-190430104__en-us_topic_0190314273_p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apic-ug-190430105.html">Creating a Custom Authorizer</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apic-ug-190430106.html">Deleting a Custom Authorizer</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-0008.html">API Opening</a></div>
</div>
</div>

View File

@ -1,74 +0,0 @@
<a name="apic-ug-190430105"></a><a name="apic-ug-190430105"></a>
<h1 class="topictitle1">Creating a Custom Authorizer</h1>
<div id="body1567734681701"><div class="notice" id="apic-ug-190430105__note393918316161"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="apic-ug-190430105__p49391539165">This feature is currently unavailable because FunctionGraph has not been launched.</p>
</div></div>
<div class="section" id="apic-ug-190430105__en-us_topic_0190314274_section82021509359"><h4 class="sectiontitle">Scenario</h4><p id="apic-ug-190430105__en-us_topic_0190314274_p1554211215447">APIG supports custom authentication of both frontend and backend requests.</p>
<ul id="apic-ug-190430105__en-us_topic_0190314274_ul2168135994418"><li id="apic-ug-190430105__en-us_topic_0190314274_li1916855920446">Frontend custom authentication: If you already have an authentication system, you can configure it in a function and then create a custom authorizer by using the function to authenticate API requests.</li><li id="apic-ug-190430105__en-us_topic_0190314274_li2443192124520">Backend custom authentication: You can create a custom authorizer to authenticate requests for different backend services, eliminating the need to customize APIs for different authentication systems and simplifying API development. You only need to create a function-based custom authorizer in APIG to connect to the backend authentication system.</li></ul>
<div class="note" id="apic-ug-190430105__en-us_topic_0190314274_note184013376469"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apic-ug-190430105__en-us_topic_0190314274_p2401537194615">Custom authentication is implemented using FunctionGraph and not supported if FunctionGraph is unavailable in the selected region.</p>
<p id="apic-ug-190430105__en-us_topic_0190314274_p1612866155615">For details about custom authentication, see <em id="apic-ug-190430105__en-us_topic_0190314274_i6558321154212">Developer Guide</em>.</p>
</div></div>
<p id="apic-ug-190430105__en-us_topic_0190314274_p175515517443">The following figure shows the process of calling APIs through custom authentication.</p>
<div class="fignone" id="apic-ug-190430105__en-us_topic_0190314274_fig6743111682417"><span class="figcap"><b>Figure 1 </b>Calling APIs through custom authentication</span><br><span><img id="apic-ug-190430105__en-us_topic_0190314274_image16681309018" src="en-us_image_0000001142758222.png"></span></div>
</div>
<div class="section" id="apic-ug-190430105__en-us_topic_0190314274_section174396106356"><h4 class="sectiontitle">Prerequisites</h4><ul id="apic-ug-190430105__ul10170203075214"><li id="apic-ug-190430105__li12170163045218">You have created a function in FunctionGraph.</li><li id="apic-ug-190430105__li1217043095218">You have the <strong id="apic-ug-190430105__b338815538574">FunctionGraph Administrator</strong> permission.</li></ul>
</div>
<div class="section" id="apic-ug-190430105__en-us_topic_0190314274_section57334161359"><h4 class="sectiontitle">Procedure</h4><ol id="apic-ug-190430105__en-us_topic_0190314274_ol1388135917558"><li id="apic-ug-190430105__en-us_topic_0190314274_li1831115541819"><span>Log in to the management console.</span></li><li id="apic-ug-190430105__en-us_topic_0190314274_li46871818394"><span>In the navigation pane, choose <strong id="apic-ug-190430105__en-us_topic_0190314274_b48248502154">Dedicated Gateways</strong>. Then click <strong id="apic-ug-190430105__en-us_topic_0190314274_b882511504154">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apic-ug-190430105__en-us_topic_0190314274_li1347811279416"><span>Choose <strong id="apic-ug-190430105__en-us_topic_0190314274_b257521317281">API Publishing</strong> &gt; <strong id="apic-ug-190430105__en-us_topic_0190314274_b728910490273">Custom Authorizers</strong>, and click <strong id="apic-ug-190430105__en-us_topic_0190314274_b15290134982714">Create Custom Authorizer</strong>.</span></li><li id="apic-ug-190430105__en-us_topic_0190314274_li132121615719"><span>Set the parameters listed in <a href="#apic-ug-190430105__table63864610016">Table 1</a>.</span><p><div class="p" id="apic-ug-190430105__p2178145813019">
<div class="tablenoborder"><a name="apic-ug-190430105__table63864610016"></a><a name="table63864610016"></a><table cellpadding="4" cellspacing="0" summary="" id="apic-ug-190430105__table63864610016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters for creating a custom authorizer</caption><thead align="left"><tr id="apic-ug-190430105__row12351746509"><th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.4.2.4.2.1.1.2.3.1.1"><p id="apic-ug-190430105__p3351461802">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="81.37%" id="mcps1.3.4.2.4.2.1.1.2.3.1.2"><p id="apic-ug-190430105__p83514461608">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="apic-ug-190430105__row8354461303"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p19351646003">Name</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><p id="apic-ug-190430105__p1354460014">Authorizer name.</p>
</td>
</tr>
<tr id="apic-ug-190430105__row15361546203"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p7351946201">Type</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><ul id="apic-ug-190430105__ul17351846804"><li id="apic-ug-190430105__li133517461607"><strong id="apic-ug-190430105__en-us_topic_0190314274_b3101910152912">Frontend</strong>: Authenticates access to APIs.</li><li id="apic-ug-190430105__li113594614015"><strong id="apic-ug-190430105__en-us_topic_0190314274_b367542302912">Backend</strong>: Authenticates access to backend services.</li></ul>
</td>
</tr>
<tr id="apic-ug-190430105__row17363461808"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p43611461305">Function URN</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><p id="apic-ug-190430105__p73611461705">Select a FunctionGraph function.</p>
</td>
</tr>
<tr id="apic-ug-190430105__row17361846807"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p17361046309">Identity Sources</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><p id="apic-ug-190430105__p10361946506">Request parameters for authentication. You can add headers and query strings. Header names are case-insensitive.</p>
<p id="apic-ug-190430105__p73614611019">This parameter is mandatory only if you set <strong id="apic-ug-190430105__en-us_topic_0190314274_b5491145922012">Type</strong> to <strong id="apic-ug-190430105__en-us_topic_0190314274_b16429554213">Frontend</strong>, and <strong id="apic-ug-190430105__en-us_topic_0190314274_b15989984210">Max. Cache Age (s)</strong> is greater than <strong id="apic-ug-190430105__en-us_topic_0190314274_b202635118211">0</strong>. When the cache is used, this parameter is used as a search criterion to query authentication results.</p>
</td>
</tr>
<tr id="apic-ug-190430105__row13794612015"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p43616469020">Max. Cache Age (s)</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><p id="apic-ug-190430105__p436154618018">The time for caching authentication results.</p>
<p id="apic-ug-190430105__p836646502">Value <strong id="apic-ug-190430105__en-us_topic_0190314274_b9619143115377">0</strong> means that authentication results will not be cached. The maximum value is <strong id="apic-ug-190430105__en-us_topic_0190314274_b1962153123718">3600</strong>.</p>
</td>
</tr>
<tr id="apic-ug-190430105__row1837846704"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p183713467015">Send Request Body</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><p id="apic-ug-190430105__p113712466017">Determine whether to send the body of each API request to the authentication function. If you enable this option, the request body will be sent to the authentication function in the same way as the headers and query strings.</p>
<div class="note" id="apic-ug-190430105__note537164616010"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="apic-ug-190430105__p163714613016">This option is available only for dedicated API gateways.</p>
</div></div>
</td>
</tr>
<tr id="apic-ug-190430105__row1381246206"><td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.1 "><p id="apic-ug-190430105__p0385461508">User Data</p>
</td>
<td class="cellrowborder" valign="top" width="81.37%" headers="mcps1.3.4.2.4.2.1.1.2.3.1.2 "><p id="apic-ug-190430105__p11381346308">Customized request parameters to be used together with <strong id="apic-ug-190430105__en-us_topic_0190314274_b97924713816">Identity Sources</strong> when APIG invokes a function.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</p></li><li id="apic-ug-190430105__en-us_topic_0190314274_li258413487573"><span>Click <strong id="apic-ug-190430105__en-us_topic_0190314274_b6229185515381">OK</strong>.</span></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apic-ug-190430104.html">Custom Authorizers</a></div>
</div>
</div>

View File

@ -1,18 +0,0 @@
<a name="apic-ug-190430106"></a><a name="apic-ug-190430106"></a>
<h1 class="topictitle1">Deleting a Custom Authorizer</h1>
<div id="body1567734682305"><div class="section" id="apic-ug-190430106__en-us_topic_0190314275_section1288124051515"><h4 class="sectiontitle">Scenario</h4><p id="apic-ug-190430106__en-us_topic_0190314275_p12350184217151">You can delete custom authorizers you no longer require.</p>
<div class="note" id="apic-ug-190430106__en-us_topic_0190314275_note64806442019"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apic-ug-190430106__en-us_topic_0190314275_ul7871145124818"><li id="apic-ug-190430106__en-us_topic_0190314275_li787154594815">Custom authentication is implemented using FunctionGraph and not supported if FunctionGraph is unavailable in the selected region.</li><li id="apic-ug-190430106__en-us_topic_0190314275_li18794544810">Custom authorizers that have been configured for APIs cannot be deleted.</li></ul>
</div></div>
</div>
<div class="section" id="apic-ug-190430106__en-us_topic_0190314275_section497534932116"><h4 class="sectiontitle">Prerequisites</h4><p id="apic-ug-190430106__en-us_topic_0190314275_p153978535219">You have <a href="apic-ug-190430105.html">created a custom authorizer</a>.</p>
</div>
<div class="section" id="apic-ug-190430106__en-us_topic_0190314275_section710174681512"><h4 class="sectiontitle">Procedure</h4><ol id="apic-ug-190430106__en-us_topic_0190314275_ol14964143051617"><li id="apic-ug-190430106__en-us_topic_0190314275_li1831115541819"><span>Log in to the management console.</span></li><li id="apic-ug-190430106__en-us_topic_0190314275_li46871818394"><span>In the navigation pane, choose <strong id="apic-ug-190430106__en-us_topic_0190314275_b187941753161510">Dedicated Gateways</strong>. Then click <strong id="apic-ug-190430106__en-us_topic_0190314275_b12799145315157">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apic-ug-190430106__en-us_topic_0190314275_li1347811279416"><span>Choose <strong id="apic-ug-190430106__en-us_topic_0190314275_b1970916431663">API Publishing</strong> &gt; <strong id="apic-ug-190430106__en-us_topic_0190314275_b92381328065">Custom Authorizers</strong>, and click <strong id="apic-ug-190430106__en-us_topic_0190314275_b6696401712">Delete</strong> in the row containing the custom authorizer you want to delete.</span></li><li id="apic-ug-190430106__en-us_topic_0190314275_li1112314390314"><span>Click <strong id="apic-ug-190430106__en-us_topic_0190314275_b5666185635119">Yes</strong>.</span></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apic-ug-190430104.html">Custom Authorizers</a></div>
</div>
</div>

View File

@ -1,45 +0,0 @@
<a name="apig-custom-policy"></a><a name="apig-custom-policy"></a>
<h1 class="topictitle1">APIG Custom Policies</h1>
<div id="body1585035631993"><p id="apig-custom-policy__en-us_topic_0232979206_p958317321214">Custom policies can be created to supplement the system-defined policies of APIG. For the actions that can be added to custom policies, see section "Permissions Policies and Supported Actions" in the <em id="apig-custom-policy__i10321123255714">API Gateway API Reference</em>.</p>
<p id="apig-custom-policy__en-us_topic_0232979206_p11763528201217">You can create custom policies using one of the following methods:</p>
<ul id="apig-custom-policy__en-us_topic_0232979206_ul87631028191213"><li id="apig-custom-policy__en-us_topic_0232979206_li176382821219">Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax.</li><li id="apig-custom-policy__en-us_topic_0232979206_li1776320280124">JSON: Edit JSON policies from scratch or based on an existing policy.</li></ul>
<p id="apig-custom-policy__en-us_topic_0232979206_p38310456104">For details, see section "Creating a Custom Policy" in the <em id="apig-custom-policy__i143671496574">Identity and Access Management User Guide</em>. The following section contains examples of common APIG custom policies.</p>
<div class="note" id="apig-custom-policy__en-us_topic_0232979206_note416314130244"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-custom-policy__en-us_topic_0232979206_p16164181311242">Only dedicated API gateways support system-defined policies and custom policies.</p>
</div></div>
<div class="section" id="apig-custom-policy__en-us_topic_0232979206_section207947385117"><h4 class="sectiontitle">Example Custom Policies</h4><ul id="apig-custom-policy__en-us_topic_0232979206_ul1379473816114"><li id="apig-custom-policy__en-us_topic_0232979206_li1679416383118">Example 1: Allow users to create and debug APIs<pre class="screen" id="apig-custom-policy__en-us_topic_0232979206_screen15794193891113">{
"Version": "1.1",
"Statement": [
{
"Effect": "Allow",
"Action": [
"
apig:apis:create
apig:apis:debug
"
]
}
]
}</pre>
</li><li id="apig-custom-policy__en-us_topic_0232979206_li87948384116">Example 2: Deny API group creation<p id="apig-custom-policy__en-us_topic_0232979206_p079415386115"><a name="apig-custom-policy__en-us_topic_0232979206_li87948384116"></a><a name="en-us_topic_0232979206_li87948384116"></a>A policy with only "Deny" permissions must be used in conjunction with other policies to take effect. If the permissions assigned to a user contain both "Allow" and "Deny", the "Deny" permissions take precedence over the "Allow" permissions.</p>
<p id="apig-custom-policy__en-us_topic_0232979206_p47946388118">The following method can be used if you need to assign permissions of the <strong id="apig-custom-policy__en-us_topic_0232979206_b6582529173710">APIG FullAccess</strong> policy to a user but you want to prevent the user from creating API groups. Create a custom policy for denying API group creation, and attach both policies to the group to which the user belongs. Then, the user can perform all operations on API gateways except creating API groups. The following is an example of a deny policy:</p>
<pre class="screen" id="apig-custom-policy__en-us_topic_0232979206_screen14794038181119">{
"Version": "1.1",
"Statement": [
{
"Effect": "Deny",
"Action": [
"apig:groups:create"
]
}
]
}</pre>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-190529107.html">Permissions Management</a></div>
</div>
</div>

View File

@ -1,17 +0,0 @@
<a name="apig-en-faq-180307001"></a><a name="apig-en-faq-180307001"></a>
<h1 class="topictitle1">What Are the Error Messages Returned by APIG Like?</h1>
<div id="body1513649176968"><p id="apig-en-faq-180307001__en-us_topic_0089391837_p8060118">When receiving an API request, APIG returns a response. A similar response body is as follows:</p>
<pre class="screen" id="apig-en-faq-180307001__en-us_topic_0089391837_screen896515153425">{
"error_code": "APIG.0101",
"error_msg": "API does not exist or is not published in the environment.",
"request_id": "acbc548ac6f2a0dbdb9e3518a7c0ff84"
}</pre>
<ul id="apig-en-faq-180307001__en-us_topic_0089391837_ul59486177221"><li id="apig-en-faq-180307001__en-us_topic_0089391837_li179482176229"><strong id="apig-en-faq-180307001__en-us_topic_0089391837_b87091310194912">"error_code"</strong>: error code</li><li id="apig-en-faq-180307001__en-us_topic_0089391837_li20234731102219"><strong id="apig-en-faq-180307001__en-us_topic_0089391837_b10517185794816">"error_msg"</strong>: description of the error</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919014.html">Other FAQs</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-180307002"></a><a name="apig-en-faq-180307002"></a>
<h1 class="topictitle1">Do I Need to Publish an API Again After Modification?</h1>
<div id="body1513649176968"><p id="apig-en-faq-180307002__en-us_topic_0089391838_p8060118">Yes. After you modify the parameters of a published API, you must publish the API again to synchronize the modifications to the environment.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919016.html">API Publishing</a></div>
</div>
</div>

View File

@ -1,14 +0,0 @@
<a name="apig-en-faq-180307003"></a><a name="apig-en-faq-180307003"></a>
<h1 class="topictitle1">How Can I Protect My APIs?</h1>
<div id="body1513649176968"><ul id="apig-en-faq-180307003__en-us_topic_0089391839_ul34341241168"><li id="apig-en-faq-180307003__en-us_topic_0089391839_li29636281068">Identity authentication<p id="apig-en-faq-180307003__en-us_topic_0089391839_p15725122910611"><a name="apig-en-faq-180307003__en-us_topic_0089391839_li29636281068"></a><a name="en-us_topic_0089391839_li29636281068"></a>Configure IAM or App authentication for APIs to prevent malicious calling.</p>
</li><li id="apig-en-faq-180307003__en-us_topic_0089391839_li334614127718">Access control policies<p id="apig-en-faq-180307003__en-us_topic_0089391839_p636214975"><a name="apig-en-faq-180307003__en-us_topic_0089391839_li334614127718"></a><a name="en-us_topic_0089391839_li334614127718"></a>Configure a whitelist or blacklist of IP addresses/IP address ranges or accounts for APIs to secure access.</p>
</li><li id="apig-en-faq-180307003__en-us_topic_0089391839_li4435424669">Request throttling policies<p id="apig-en-faq-180307003__en-us_topic_0089391839_p8060118"><a name="apig-en-faq-180307003__en-us_topic_0089391839_li4435424669"></a><a name="en-us_topic_0089391839_li4435424669"></a>By default, an API can be called up to 200 times per second. If your backend service does not support this access rate, decrease the quota accordingly.</p>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919015.html">API Security</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-180307004"></a><a name="apig-en-faq-180307004"></a>
<h1 class="topictitle1">Can Mobile Apps Call APIs?</h1>
<div id="body1513649176968"><p id="apig-en-faq-180307004__en-us_topic_0089391840_p8060118">Yes, mobile apps can call APIs. In app authentication mode, the AppKey and AppSecret of a mobile app are replaced with those in the relevant SDK to sign the app.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919017.html">API Calling</a></div>
</div>
</div>

View File

@ -1,14 +0,0 @@
<a name="apig-en-faq-180307006"></a><a name="apig-en-faq-180307006"></a>
<h1 class="topictitle1">Can I Upload Files Using the POST Method?</h1>
<div id="body1513649176968"><p id="apig-en-faq-180307006__en-us_topic_0089391842_p25248191833">Yes.</p>
<p id="apig-en-faq-180307006__en-us_topic_0089391842_p1636918478318">If you are using dedicated gateways, configure the maximum request body size allowed by setting the <strong id="apig-en-faq-180307006__b31709553616">request_body_size</strong> parameter. The value ranges from 1 MB to 9536 MB.</p>
<div class="note" id="apig-en-faq-180307006__note20886171145913"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-faq-180307006__p28878125912">Currently, only the request body can be transparently transmitted.</p>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919014.html">Other FAQs</a></div>
</div>
</div>

View File

@ -1,38 +0,0 @@
<a name="apig-en-faq-180307008"></a><a name="apig-en-faq-180307008"></a>
<h1 class="topictitle1">Can Applications Deployed in a VPC Call APIs?</h1>
<div id="body1513827940996"><p id="apig-en-faq-180307008__en-us_topic_0089872475_p147418307461">Yes, applications deployed in a VPC can call APIs by default. If domain name resolution fails, configure a DNS server on the current endpoint by following the instructions in <a href="#apig-en-faq-180307008__en-us_topic_0089872475_section856622113118">Configuring an Intranet DNS Server</a>. After the configuration, applications deployed in the VPC can call APIs.</p>
<div class="section" id="apig-en-faq-180307008__en-us_topic_0089872475_section856622113118"><a name="apig-en-faq-180307008__en-us_topic_0089872475_section856622113118"></a><a name="en-us_topic_0089872475_section856622113118"></a><h4 class="sectiontitle">Configuring an Intranet DNS Server</h4><p class="MsoNormal" id="apig-en-faq-180307008__en-us_topic_0089872475_p59002044">To configure a DNS server, specify its IP address in the <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b1055789353172254">/etc/resolv.conf</strong> file.</p>
<p class="MsoNormal" id="apig-en-faq-180307008__p686935132811">The IP address of the intranet DNS server depends on which region you are located in. Find the IP address of the intranet DNS server in your region from the private DNS server addresses mentioned in the <em id="apig-en-faq-180307008__i1311645362213">Domain Name Service FAQs</em>.</p>
<p id="apig-en-faq-180307008__en-us_topic_0089872475_p1345182812445">Add an intranet DNS server with either of the following two methods:</p>
<ul id="apig-en-faq-180307008__en-us_topic_0089872475_ul72651733194414"><li id="apig-en-faq-180307008__en-us_topic_0089872475_li164310423442">Method 1: Modify the subnet information of the VPC.</li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li183471853154410">Method 2: Edit the <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b842352706172843">/etc/resolv.conf</strong> file.<div class="note" id="apig-en-faq-180307008__en-us_topic_0089872475_note95521833153019"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-faq-180307008__en-us_topic_0089872475_p6553833183013">The intranet DNS server configurations become invalid after the ECS restarts, and the intranet DNS server must be configured again. Therefore, method 1 is recommended.</p>
</div></div>
</li></ul>
</div>
<div class="section" id="apig-en-faq-180307008__en-us_topic_0089872475_section15385141315316"><h4 class="sectiontitle">Method 1</h4><p id="apig-en-faq-180307008__en-us_topic_0089872475_p132171223113117">Perform the following procedure to add a DNS server IP address to the subnet configurations of the ECS in the VPC. </p>
<ol id="apig-en-faq-180307008__en-us_topic_0089872475_ol6442141303113"><li id="apig-en-faq-180307008__en-us_topic_0089872475_li144113139313"><span>Log in to the management console.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_en-us_topic_0080101678_li1763225213319"><span>Click <span><img id="apig-en-faq-180307008__image1373385310416" src="en-us_image_0143929918.png"></span> in the upper left corner to select a region.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_en-us_topic_0080101678_li2936408718728"><span>In the service list, choose <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b7123125331317">Compute</strong> &gt; <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b24831507132">Elastic Cloud Server</strong>.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li18441151343112"><span>Click the name of the ECS you want to use.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li16910204134212"><a name="apig-en-faq-180307008__en-us_topic_0089872475_li16910204134212"></a><a name="en-us_topic_0089872475_li16910204134212"></a><span>On the ECS details page, view the NIC information, and click <span><img id="apig-en-faq-180307008__en-us_topic_0089872475_image416924811155" src="en-us_image_0000001143167164.png"></span> to view the subnet name of the ECS.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li144411613133111"><span>On the ECS basic information page, view the VPC name of the ECS.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li18176162024812"><span>Click the VPC name to visit the VPC console.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li1644111318311"><span>Choose <strong id="apig-en-faq-180307008__b163191110185317">Subnets</strong> in the left navigation pane.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li1844191363111"><span>Locate the subnet mentioned in <a href="#apig-en-faq-180307008__en-us_topic_0089872475_li16910204134212">5</a> and click the subnet name.</span></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li13041961595"><span>Change the DNS server address of the subnet and click <strong id="apig-en-faq-180307008__b1252193935514">OK</strong>.</span><p><p id="apig-en-faq-180307008__en-us_topic_0089872475_p18639127115918">For example, change the address to <strong id="apig-en-faq-180307008__b1723254445514">100.125.1.250</strong>.</p>
</p></li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li4442191314311"><span>Restart the ECS. Check that the <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b842352706174213">/etc/resolv.conf</strong> file contains the IP address of the DNS server to be configured, and the IP address is less than those of all other DNS servers.</span><p><p id="apig-en-faq-180307008__en-us_topic_0089872475_p1744762315">The following figure shows the IP address <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b1761053182912">100.125.1.250</strong> of the DNS server to be configured.</p>
<p class="MsoNormal" id="apig-en-faq-180307008__en-us_topic_0089872475_p122471635311"><span><img id="apig-en-faq-180307008__en-us_topic_0089872475_image72477313318" src="en-us_image_0000001189007099.png" title="Click to enlarge" class="imgResize"></span></p>
<div class="note" id="apig-en-faq-180307008__en-us_topic_0089872475_note1124710320315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="NotesText" id="apig-en-faq-180307008__en-us_topic_0089872475_p12476310314">Modifying the subnet information of a VPC will affect all ECSs created using the subnet.</p>
</div></div>
</p></li></ol>
</div>
<div class="section" id="apig-en-faq-180307008__en-us_topic_0089872475_section20214194333211"><h4 class="sectiontitle">Method 2</h4><p id="apig-en-faq-180307008__en-us_topic_0089872475_p156831510151">Add the IP address of the intranet DNS server to the <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b159875416213">/etc/resolv.conf</strong> file.</p>
<p id="apig-en-faq-180307008__en-us_topic_0089872475_p11442213133115">For example, if you are located in <strong id="apig-en-faq-180307008__b1952045782019">region01</strong>, add an intranet DNS server of IP address <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b8527626143217">100.125.1.250</strong> to the <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b14591231193215">/etc/resolv.conf</strong> file.</p>
<div class="note" id="apig-en-faq-180307008__en-us_topic_0089872475_note1144471319312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-en-faq-180307008__en-us_topic_0089872475_ul125968273610"><li id="apig-en-faq-180307008__en-us_topic_0089872475_li17596427567">The IP address of the new DNS server must be less than those of all other DNS servers.</li><li id="apig-en-faq-180307008__en-us_topic_0089872475_li17343143010613">The DNS configurations take effect immediately after the <strong id="apig-en-faq-180307008__en-us_topic_0089872475_b141657157343">/etc/resolv.conf</strong> file is saved.</li></ul>
</div></div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919017.html">API Calling</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

View File

@ -1,15 +0,0 @@
<a name="apig-en-faq-180307009"></a><a name="apig-en-faq-180307009"></a>
<h1 class="topictitle1">How Do I Ensure the Security of Backend Services Invoked by APIG?</h1>
<div id="body1516602210259"><p id="apig-en-faq-180307009__en-us_topic_0093963882_p1941784211261">You can ensure the security of backend services invoked by APIG by using the following methods:</p>
<ul id="apig-en-faq-180307009__en-us_topic_0093963882_ul1489013506289"><li id="apig-en-faq-180307009__en-us_topic_0093963882_li3412153302211">Bind signature keys to APIs<p id="apig-en-faq-180307009__en-us_topic_0093963882_p42472034152214"><a name="apig-en-faq-180307009__en-us_topic_0093963882_li3412153302211"></a><a name="en-us_topic_0093963882_li3412153302211"></a>After a signature key is bound to an API, APIG adds signature information to each request sent to the backend service. The backend service calculates the signature information in each request and checks whether the signature information is consistent with that on APIG.</p>
</li><li id="apig-en-faq-180307009__en-us_topic_0093963882_li18433173610221">Encrypt requests using HTTPS<p id="apig-en-faq-180307009__en-us_topic_0093963882_p1449414376223"><a name="apig-en-faq-180307009__en-us_topic_0093963882_li18433173610221"></a><a name="en-us_topic_0093963882_li18433173610221"></a>Ensure that the required SSL certificate exists.</p>
</li><li id="apig-en-faq-180307009__en-us_topic_0093963882_li112921560139">Perform backend authentication<p id="apig-en-faq-180307009__en-us_topic_0093963882_p563031151613"><a name="apig-en-faq-180307009__en-us_topic_0093963882_li112921560139"></a><a name="en-us_topic_0093963882_li112921560139"></a>Enable security authentication for backend services of the desired APIs to process only API requests that carry correct authentication information.</p>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919015.html">API Security</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-180606010"></a><a name="apig-en-faq-180606010"></a>
<h1 class="topictitle1">What SDK Languages Does APIG Support?</h1>
<div id="body1527296467241"><p id="apig-en-faq-180606010__en-us_topic_0114206515_p8060118">APIG supports Java, Go, Python, C#, JavaScript, PHP, C++, C, and Android SDKs.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919014.html">Other FAQs</a></div>
</div>
</div>

View File

@ -1,13 +0,0 @@
<a name="apig-en-faq-180606011"></a><a name="apig-en-faq-180606011"></a>
<h1 class="topictitle1">Why Can't APIs Published in a Non-RELEASE Environment Be Accessed?</h1>
<div id="body1527296467241"><p id="apig-en-faq-180606011__p250644182516">To make an API published in a non-RELEASE environment accessible, add the <strong id="apig-en-faq-180606011__b16663939194518">x-stage</strong> header to the API request.</p>
<p id="apig-en-faq-180606011__en-us_topic_0114206516_p8060118">Example:</p>
<pre class="screen" id="apig-en-faq-180606011__screen1337204919247">r.Header.Add("x-stage", "RELEASE")</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919016.html">API Publishing</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-180606012"></a><a name="apig-en-faq-180606012"></a>
<h1 class="topictitle1">Does APIG Support Multiple Backend Endpoints?</h1>
<div id="body1527296467241"><p id="apig-en-faq-180606012__en-us_topic_0114206517_p8060118">Yes. APIG supports the configuration of multiple backend endpoints through a VPC channel (also called "load balance channel"). You can add multiple cloud servers to each VPC channel.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-faq-create.html">API Creation</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-180606013"></a><a name="apig-en-faq-180606013"></a>
<h1 class="topictitle1">What Is the Maximum Size of an API Request Package?</h1>
<div id="body1527296467241"><p id="apig-en-faq-180606013__en-us_topic_0114206518_p1636918478318">Dedicated gateway: APIG forwards only API requests whose body is no larger than 12 MB. If your gateway will receive requests with a body larger than 12 MB, modify the <strong id="apig-en-faq-180606013__b939515012394">request_body_size</strong> parameter on the gateway details page. This parameter indicates the maximum request body size allowed. The value ranges from 1 MB to 9536 MB.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919017.html">API Calling</a></div>
</div>
</div>

View File

@ -1,29 +0,0 @@
<a name="apig-en-faq-180919014"></a><a name="apig-en-faq-180919014"></a>
<h1 class="topictitle1">Other FAQs</h1>
<div id="body1537328448508"><p id="apig-en-faq-180919014__en-us_topic_0132100546_p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0084464485.html">What Are the Relationships Between an API, Environment, and App?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0084464486.html">How Can I Use APIG?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-faq-180606010.html">What SDK Languages Does APIG Support?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-faq-180307006.html">Can I Upload Files Using the POST Method?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-faq-180307001.html">What Are the Error Messages Returned by APIG Like?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-faq-20210414.html">Can APIG Be Deployed in a Local Data Center?</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-cmccfaq.html">FAQs</a></div>
</div>
</div>

View File

@ -1,19 +0,0 @@
<a name="apig-en-faq-180919015"></a><a name="apig-en-faq-180919015"></a>
<h1 class="topictitle1">API Security</h1>
<div id="body1537328448508"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-en-faq-180307003.html">How Can I Protect My APIs?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-faq-180307009.html">How Do I Ensure the Security of Backend Services Invoked by APIG?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-faq-191201.html">Can I Control Access to the Private IP Addresses of the ECSs in a VPC Channel (or Load Balance Channel)?</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-cmccfaq.html">FAQs</a></div>
</div>
</div>

View File

@ -1,25 +0,0 @@
<a name="apig-en-faq-180919016"></a><a name="apig-en-faq-180919016"></a>
<h1 class="topictitle1">API Publishing</h1>
<div id="body1537328981429"><p id="apig-en-faq-180919016__en-us_topic_0132117927_p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-en-faq-180307002.html">Do I Need to Publish an API Again After Modification?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-faq-180606011.html">Why Can't APIs Published in a Non-RELEASE Environment Be Accessed?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-faq-181016019.html">Can I Invoke Different Backend Services by Publishing an API in Different Environments?</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-faq-2005027.html">How Do I Specify an Environment for API Debugging?</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-cmccfaq.html">FAQs</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-181016018"></a><a name="apig-en-faq-181016018"></a>
<h1 class="topictitle1">Why Am I Seeing the Message "No backend available"?</h1>
<div id="body1539658342364"><ul id="apig-en-faq-181016018__en-us_topic_0135442565_ul1258265171417"><li id="apig-en-faq-181016018__en-us_topic_0135442565_li658295121417">Check whether the backend service is accessible, and modify the backend service if it is inaccessible.</li><li id="apig-en-faq-181016018__en-us_topic_0135442565_li3582135151415">Check the ECS security group configurations of the backend service and verify that the required port has been enabled.</li><li id="apig-en-faq-181016018__en-us_topic_0135442565_li4582451131412">Check whether ACL configurations of the VPC restrict the communication between the API gateway and the subnet where the backend service is located.</li><li id="apig-en-faq-181016018__en-us_topic_0135442565_li328135541419">If you use a VPC channel, check whether the service port, health check port, and backend servers of the VPC channel have been correctly configured.</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919017.html">API Calling</a></div>
</div>
</div>

View File

@ -1,11 +0,0 @@
<a name="apig-en-faq-181016019"></a><a name="apig-en-faq-181016019"></a>
<h1 class="topictitle1">Can I Invoke Different Backend Services by Publishing an API in Different Environments?</h1>
<div id="body1539658342364"><p id="apig-en-faq-181016019__en-us_topic_0135442566_p13200165711416">Yes, you can invoke different backend services by publishing an API in different environments while specifying environment variables and backend parameters.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-faq-180919016.html">API Publishing</a></div>
</div>
</div>

View File

@ -1,27 +0,0 @@
<a name="apig-en-ug-180307001"></a><a name="apig-en-ug-180307001"></a>
<h1 class="topictitle1">Opening APIs</h1>
<div id="body1511090188350"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-en-ug-180307002.html">Process Flow</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307003.html">Creating an API Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-ug-190419107.html">Binding a Domain Name</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0080101678.html">Creating an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-ug-190419108.html">Debugging an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307004.html">(Optional) Creating an Environment</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307005.html">Publishing an API</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-0012.html">Getting Started</a></div>
</div>
</div>

View File

@ -1,28 +0,0 @@
<a name="apig-en-ug-180307002"></a><a name="apig-en-ug-180307002"></a>
<h1 class="topictitle1">Process Flow</h1>
<div id="body1508204232679"><p id="apig-en-ug-180307002__en-us_topic_0080101676_p8060118">The following figure shows the process of exposing an API.</p>
<p id="apig-en-ug-180307002__p18543548134311"><span><img id="apig-en-ug-180307002__image14730133294617" src="en-us_image_0000001182465263.png" title="Click to enlarge" class="imgResize"></span></p>
<ol id="apig-en-ug-180307002__en-us_topic_0080101676_ol134712352910"><li id="apig-en-ug-180307002__li035223651911">Creating a Gateway<p id="apig-en-ug-180307002__p147514598126"><a name="apig-en-ug-180307002__li035223651911"></a><a name="li035223651911"></a>Buy a dedicated gateway. For details, see <a href="apig-ug-191004.html">Buying a Dedicated Gateway</a>. </p>
<p id="apig-en-ug-180307002__p08351451237"></p>
</li><li id="apig-en-ug-180307002__en-us_topic_0080101676_li1934718315294"><a href="apig-en-ug-180307003.html">Creating an API Group</a><p id="apig-en-ug-180307002__en-us_topic_0080101676_p52731551293">An API group facilitates management of APIs used for the same service. Create an API group and then create APIs.</p>
</li><li id="apig-en-ug-180307002__en-us_topic_0080101676_li1239042116208"><a href="apig-ug-190419107.html">Binding a Domain Name</a><p id="apig-en-ug-180307002__en-us_topic_0080101676_p1939022115203">Before making the API available for users to access, bind an independent domain name (custom domain name) to the group to which the API belongs. Then API callers can use these domain names to call the API.</p>
</li><li id="apig-en-ug-180307002__en-us_topic_0080101676_li034715392911"><a href="en-us_topic_0080101678.html">Creating an API</a><p id="apig-en-ug-180307002__en-us_topic_0080101676_p1396201052917">When creating an API, configure the frontend and backend request paths, parameters, and protocols.</p>
</li><li id="apig-en-ug-180307002__en-us_topic_0080101676_li1447643191811"><a href="apig-ug-190419108.html">Debugging an API</a><p id="apig-en-ug-180307002__en-us_topic_0080101676_p18728145518188">Debug the API to check whether it works normally.</p>
</li><li id="apig-en-ug-180307002__en-us_topic_0080101676_li23471332910"><a href="apig-en-ug-180307004.html">(Optional) Creating an Environment</a><p id="apig-en-ug-180307002__en-us_topic_0080101676_p10254142615218">An API can be called in different scenarios, such as the production environment (RELEASE) or other custom environments. RELEASE is the default environment defined in APIG.</p>
</li><li id="apig-en-ug-180307002__en-us_topic_0080101676_li134733102913"><a href="apig-en-ug-180307005.html">Publishing an API</a><p id="apig-en-ug-180307002__en-us_topic_0080101676_p780511012155">Publish the API so that it can be called.</p>
</li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307001.html">Opening APIs</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

View File

@ -1,32 +0,0 @@
<a name="apig-en-ug-180307003"></a><a name="apig-en-ug-180307003"></a>
<h1 class="topictitle1">Creating an API Group</h1>
<div id="body1508204232679"><ol id="apig-en-ug-180307003__en-us_topic_0080101677_en-us_topic_0089184725_en-us_topic_0080101677_ol43115541812"><li id="apig-en-ug-180307003__li174331760019"><span>Log in to the APIG console.</span></li><li id="apig-en-ug-180307003__li275441511522"><span>Access the <a href="apig-ug-191004.html">dedicated gateway you purchased</a>.</span></li><li id="apig-en-ug-180307003__en-us_topic_0080101677_en-us_topic_0089184725_en-us_topic_0080101677_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307003__b6308167183616">API Publishing</strong> &gt; <strong id="apig-en-ug-180307003__b231617163612">API Groups</strong>.</span></li><li id="apig-en-ug-180307003__en-us_topic_0080101677_en-us_topic_0089184725_en-us_topic_0080101677_li3311165411110"><span>Click <strong id="apig-en-ug-180307003__b1145915146433">Create API Group</strong> and configure group information.</span><p><div class="p" id="apig-en-ug-180307003__p116093312475">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apig-en-ug-180307003__table895845134614" frame="border" border="1" rules="all"><caption><b>Table 1 </b>API group information</caption><thead align="left"><tr id="apig-en-ug-180307003__row17941745204619"><th align="left" class="cellrowborder" valign="top" width="31.03%" id="mcps1.3.1.4.2.1.1.2.3.1.1"><p id="apig-en-ug-180307003__p6941545144618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68.97%" id="mcps1.3.1.4.2.1.1.2.3.1.2"><p id="apig-en-ug-180307003__p6941045154620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="apig-en-ug-180307003__row1895194520463"><td class="cellrowborder" valign="top" width="31.03%" headers="mcps1.3.1.4.2.1.1.2.3.1.1 "><p id="apig-en-ug-180307003__p894164517462">Name</p>
</td>
<td class="cellrowborder" valign="top" width="68.97%" headers="mcps1.3.1.4.2.1.1.2.3.1.2 "><p id="apig-en-ug-180307003__p9951745114620">API group name. It is recommended that you enter a name based on naming rules to facilitate search.</p>
</td>
</tr>
<tr id="apig-en-ug-180307003__row995194524614"><td class="cellrowborder" valign="top" width="31.03%" headers="mcps1.3.1.4.2.1.1.2.3.1.1 "><p id="apig-en-ug-180307003__p1695645104618">Description</p>
</td>
<td class="cellrowborder" valign="top" width="68.97%" headers="mcps1.3.1.4.2.1.1.2.3.1.2 "><p id="apig-en-ug-180307003__p1795845134612">Description of the API group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</p></li><li id="apig-en-ug-180307003__en-us_topic_0080101677_en-us_topic_0089184725_en-us_topic_0080101677_li33111754410"><span>Click <strong id="apig-en-ug-180307003__b757334163917">OK</strong>. The system automatically allocates a subdomain name to the API group. APIs in the group can be debugged using the domain name.</span></li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307001.html">Opening APIs</a></div>
</div>
</div>

View File

@ -1,32 +0,0 @@
<a name="apig-en-ug-180307004"></a><a name="apig-en-ug-180307004"></a>
<h1 class="topictitle1">(Optional) Creating an Environment</h1>
<div id="body1508204796733"><ol id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_en-us_topic_0080102731_ol43115541812"><li id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_en-us_topic_0080102731_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_b7342115452819">API Publishing</strong> &gt; <strong id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_b10342165412284">Environments</strong>.</span></li><li id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_en-us_topic_0080102731_li3311165411110"><span>Click <strong id="apig-en-ug-180307004__b2073643054314">Create Environment</strong> and set the environment information.</span><p><div class="p" id="apig-en-ug-180307004__p19953134310379">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apig-en-ug-180307004__table1286551813717" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Environment information</caption><thead align="left"><tr id="apig-en-ug-180307004__row786401863715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.1.2.2.1.1.2.3.1.1"><p id="apig-en-ug-180307004__p19864518193717">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="80%" id="mcps1.3.1.2.2.1.1.2.3.1.2"><p id="apig-en-ug-180307004__p15864201818370">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="apig-en-ug-180307004__row1086431823713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.2.1.1.2.3.1.1 "><p id="apig-en-ug-180307004__p118641718133718">Name</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.2.1.1.2.3.1.2 "><p id="apig-en-ug-180307004__p138641189377">Environment name. It is recommended that you enter a name based on naming rules to facilitate search.</p>
</td>
</tr>
<tr id="apig-en-ug-180307004__row68652184371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.2.1.1.2.3.1.1 "><p id="apig-en-ug-180307004__p1865161843712">Description</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.2.1.1.2.3.1.2 "><p id="apig-en-ug-180307004__p686571813372">Description of the environment.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</p></li><li id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_en-us_topic_0080102731_li27031236164915"><span>Click <strong id="apig-en-ug-180307004__en-us_topic_0080102731_en-us_topic_0114941621_b842352706184714">OK</strong>.</span></li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307001.html">Opening APIs</a></div>
</div>
</div>

View File

@ -1,12 +0,0 @@
<a name="apig-en-ug-180307005"></a><a name="apig-en-ug-180307005"></a>
<h1 class="topictitle1">Publishing an API</h1>
<div id="body1511439357859"><ol id="apig-en-ug-180307005__en-us_topic_0085245354_en-us_topic_0080103325_en-us_topic_0085245354_ol43115541812"><li id="apig-en-ug-180307005__en-us_topic_0085245354_en-us_topic_0080103325_en-us_topic_0085245354_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307005__b188749327465">API Publishing</strong> &gt; <strong id="apig-en-ug-180307005__b14884173217463">APIs</strong>.</span></li><li id="apig-en-ug-180307005__en-us_topic_0085245354_en-us_topic_0080103325_en-us_topic_0085245354_li63871220171114"><span>Locate the API created in <a href="en-us_topic_0080101678.html">Creating an API</a>, and click <strong id="apig-en-ug-180307005__b23716184712">Publish</strong>.</span></li><li id="apig-en-ug-180307005__en-us_topic_0085245354_en-us_topic_0080103325_en-us_topic_0085245354_li17854113512"><span>Select the environment where the API will be published.</span><p><p id="apig-en-ug-180307005__p13845331174012"></p>
</p></li><li id="apig-en-ug-180307005__en-us_topic_0085245354_en-us_topic_0080103325_en-us_topic_0085245354_li38613145118"><span>Click <strong id="apig-en-ug-180307005__b84978388293">Publish</strong>.</span></li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307001.html">Opening APIs</a></div>
</div>
</div>

View File

@ -1,21 +0,0 @@
<a name="apig-en-ug-180307007"></a><a name="apig-en-ug-180307007"></a>
<h1 class="topictitle1">Calling APIs</h1>
<div id="body1511404114797"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-en-ug-180307008.html">Process Flow</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307010.html">Creating an App and Getting Authorized</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307009.html">Adding an AppCode for Simple Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307011.html">Calling an API</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-0012.html">Getting Started</a></div>
</div>
</div>

View File

@ -1,18 +0,0 @@
<a name="apig-en-ug-180307008"></a><a name="apig-en-ug-180307008"></a>
<h1 class="topictitle1">Process Flow</h1>
<div id="body1511404114797"><p id="apig-en-ug-180307008__en-us_topic_0085149604_p21911839154311">The following figure shows the process of calling an API.</p>
<p id="apig-en-ug-180307008__p298135814519"><span><img id="apig-en-ug-180307008__image2794141704" src="en-us_image_0000001142638662.png"></span></p>
<p id="apig-en-ug-180307008__p181111515304"></p>
<ol id="apig-en-ug-180307008__en-us_topic_0085149604_ol26845418413"><li id="apig-en-ug-180307008__en-us_topic_0085149604_li1934718315294">Obtaining an API<p id="apig-en-ug-180307008__p870144816278"><a name="apig-en-ug-180307008__en-us_topic_0085149604_li1934718315294"></a><a name="en-us_topic_0085149604_li1934718315294"></a>Obtain an API and its documentation from an API provider.</p>
</li><li id="apig-en-ug-180307008__en-us_topic_0085149604_li034715392911"><a href="apig-en-ug-180307010.html">Creating an App and Getting Authorized</a><p id="apig-en-ug-180307008__p026518814305">APIs that use app authentication can only be called using apps bound to them.</p>
</li><li id="apig-en-ug-180307008__li10481112215013"><a href="apig-en-ug-180307009.html">Adding an AppCode for Simple Authentication</a><p id="apig-en-ug-180307008__p12605544153420">APIG only verifies the AppCode during simple authentication.</p>
</li><li id="apig-en-ug-180307008__en-us_topic_0085149604_li186871442042"><a href="apig-en-ug-180307011.html">Calling the API</a><p id="apig-en-ug-180307008__p1987765311304">Use an API test tool to call the API with app authentication credentials.</p>
</li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307007.html">Calling APIs</a></div>
</div>
</div>

View File

@ -1,12 +0,0 @@
<a name="apig-en-ug-180307009"></a><a name="apig-en-ug-180307009"></a>
<h1 class="topictitle1">Adding an AppCode for Simple Authentication</h1>
<div id="body1511404114797"><ol id="apig-en-ug-180307009__ol5288720202717"><li id="apig-en-ug-180307009__li12288172082714"><span>In the app list, click the app created in <a href="apig-en-ug-180307010.html">Creating an App and Getting Authorized</a> to go to the app details page.</span></li><li id="apig-en-ug-180307009__li1720682113280"><span>Click the <strong id="apig-en-ug-180307009__b2911325662">AppCodes</strong> tab.</span></li><li id="apig-en-ug-180307009__li854814547286"><span>Click <strong id="apig-en-ug-180307009__b67227211371">Add AppCode</strong>.</span></li><li id="apig-en-ug-180307009__li1293513496290"><span>Select <strong id="apig-en-ug-180307009__b4584541787">Automatically generated</strong>.</span><p><p id="apig-en-ug-180307009__p4928142545616"></p>
</p></li><li id="apig-en-ug-180307009__li1431525193011"><span>Click <strong id="apig-en-ug-180307009__b35811661587">OK</strong>.</span></li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307007.html">Calling APIs</a></div>
</div>
</div>

View File

@ -1,35 +0,0 @@
<a name="apig-en-ug-180307010"></a><a name="apig-en-ug-180307010"></a>
<h1 class="topictitle1">Creating an App and Getting Authorized</h1>
<div id="body1511404114797"><div class="section" id="apig-en-ug-180307010__section101812113415"><h4 class="sectiontitle">Creating an App</h4><ol id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_ol43115541812"><li id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307010__b27031933195717">API Calling</strong> &gt; <strong id="apig-en-ug-180307010__b67158333570">Apps</strong>.</span></li><li id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_li3311165411110"><span>Click <strong id="apig-en-ug-180307010__b104181339115710">Create App</strong> and set basic app information.</span><p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apig-en-ug-180307010__table84025541401" frame="border" border="1" rules="all"><caption><b>Table 1 </b>App information</caption><thead align="left"><tr id="apig-en-ug-180307010__row16401554124015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.1.2.2.2.1.2.3.1.1"><p id="apig-en-ug-180307010__p4401135414014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="80%" id="mcps1.3.1.2.2.2.1.2.3.1.2"><p id="apig-en-ug-180307010__p1540120546409">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="apig-en-ug-180307010__row64012054164018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.2.2.1.2.3.1.1 "><p id="apig-en-ug-180307010__p1340125484014">Name</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.2.2.1.2.3.1.2 "><p id="apig-en-ug-180307010__p14011654204012">App name. It is recommended that you enter a name based on naming rules to facilitate search.</p>
</td>
</tr>
<tr id="apig-en-ug-180307010__row5401854124012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.2.2.1.2.3.1.1 "><p id="apig-en-ug-180307010__p440114548408">Description</p>
</td>
<td class="cellrowborder" valign="top" width="80%" headers="mcps1.3.1.2.2.2.1.2.3.1.2 "><p id="apig-en-ug-180307010__p1640165484017">Description of the app.</p>
</td>
</tr>
</tbody>
</table>
</div>
</p></li><li id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_li82808566572"><span>Click <strong id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_b84235270692711">OK</strong>.</span></li></ol>
</div>
<div class="section" id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_section3685125783812"><h4 class="sectiontitle">Binding an App to an API</h4><ol id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_ol19155171132916"><li id="apig-en-ug-180307010__li1058610301665"><span>In the <strong id="apig-en-ug-180307010__b5673142195818">Operation</strong> column of the created app, click <strong id="apig-en-ug-180307010__b116731221165814">Bind to API</strong>, and then click <strong id="apig-en-ug-180307010__b8673102114584">Select API</strong>.</span></li><li id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_li81561011192910"><span>At the top of the API list, click <strong id="apig-en-ug-180307010__b19985951125816">Select API</strong>.</span></li><li id="apig-en-ug-180307010__en-us_topic_0085149606_en-us_topic_0115925970_en-us_topic_0085149606_li6105152922315"><span>Select the environment, API group, and API created in <a href="apig-en-ug-180307001.html">Opening APIs</a>, and click <strong id="apig-en-ug-180307010__b125493237591">OK</strong>.</span><p><p id="apig-en-ug-180307010__p9976103194612"></p>
</p></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307007.html">Calling APIs</a></div>
</div>
</div>

View File

@ -1,22 +0,0 @@
<a name="apig-en-ug-180307011"></a><a name="apig-en-ug-180307011"></a>
<h1 class="topictitle1">Calling an API</h1>
<div id="body1508204796733"><p id="apig-en-ug-180307011__p983924561117">Use an API test tool to configure the API calling information.</p>
<ol id="apig-en-ug-180307011__ol204944615405"><li id="apig-en-ug-180307011__li13835113641320"><span>Obtain the API request information.</span><p><p id="apig-en-ug-180307011__p136491513488">For illustration purposes, an API and its documentation are obtained through offline channels. You can also obtain the authentication mode, request method, request path, and other information about the API.</p>
</p></li><li id="apig-en-ug-180307011__li4393141012538"><span>Add the header parameter <strong id="apig-en-ug-180307011__b1686713326131">X-Apig-AppCode</strong> and set the parameter value to the <a href="apig-en-ug-180307009.html">generated AppCode</a>.</span></li><li id="apig-en-ug-180307011__li1720018219474"><span>Add the header parameter <strong id="apig-en-ug-180307011__b1530450151411">x-stage</strong> and set the parameter value to the <a href="apig-en-ug-180307004.html">running environment</a>. Skip this step if the API has been published in the RELEASE environment.</span></li><li id="apig-en-ug-180307011__li19653744488"><span>Click <strong id="apig-en-ug-180307011__b111510417161">Send</strong> to send a request.</span><p><p id="apig-en-ug-180307011__p13191182917174">If the API is called successfully, the message <strong id="apig-en-ug-180307011__b91131542141618">200 OK</strong> is displayed.</p>
<p id="apig-en-ug-180307011__p13637132614176"><span><img id="apig-en-ug-180307011__image013818215597" src="en-us_image_0000001188579631.png" title="Click to enlarge" class="imgResize"></span></p>
</p></li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307007.html">Calling APIs</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

View File

@ -1,21 +0,0 @@
<a name="apig-en-ug-180307014"></a><a name="apig-en-ug-180307014"></a>
<h1 class="topictitle1">API Group Management</h1>
<div id="body1511232545602"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-en-ug-180307015.html">Creating an API Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180327076.html">Binding a Domain Name</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307018.html">Deleting an API Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-lgug-200226001.html">Adding a Gateway Response</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-0008.html">API Opening</a></div>
</div>
</div>

View File

@ -1,41 +0,0 @@
<a name="apig-en-ug-180307015"></a><a name="apig-en-ug-180307015"></a>
<h1 class="topictitle1">Creating an API Group</h1>
<div id="body8662426"><div class="section" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_section1731012541118"><h4 class="sectiontitle">Scenario</h4><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p1931010545114">Before creating an API, you must create an API group. An API group contains different APIs used for the same service.</p>
<div class="note" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_note1442918804515"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-ug-180307015__p11608521296">Each API can only belong to one API group.</p>
</div></div>
</div>
<div class="section" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_section8731554122615"><h4 class="sectiontitle">Procedure</h4><ol id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_ol43115541812"><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li1831115541819"><span>Log in to the management console.</span></li><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li46871818394"><span>In the navigation pane, choose <strong id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_b12907459186">Dedicated Gateways</strong>. Then click <strong id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_b1191285913811">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_b18158175701515">API Publishing</strong> &gt; <strong id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_b21581857161514">API Groups</strong>.</span></li><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li3311165411110"><span>Click <strong id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_b19457133621120">Create API Group</strong>, and set the parameters described in <a href="#apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_table195413315428">Table 1</a>.</span><p>
<div class="tablenoborder"><a name="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_table195413315428"></a><a name="en-us_topic_0089184725_en-us_topic_0080101677_table195413315428"></a><table cellpadding="4" cellspacing="0" summary="" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_table195413315428" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters for creating an API group</caption><thead align="left"><tr id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_row45523384220"><th align="left" class="cellrowborder" valign="top" width="31.03%" id="mcps1.3.2.2.4.2.1.2.3.1.1"><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p65563314423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68.97%" id="mcps1.3.2.2.4.2.1.2.3.1.2"><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p356183311427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_row1156183364219"><td class="cellrowborder" valign="top" width="31.03%" headers="mcps1.3.2.2.4.2.1.2.3.1.1 "><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p105616333427">Name</p>
</td>
<td class="cellrowborder" valign="top" width="68.97%" headers="mcps1.3.2.2.4.2.1.2.3.1.2 "><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p1656123374219">API group name.</p>
</td>
</tr>
<tr id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_row14879114316433"><td class="cellrowborder" valign="top" width="31.03%" headers="mcps1.3.2.2.4.2.1.2.3.1.1 "><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p12880154304320">Description</p>
</td>
<td class="cellrowborder" valign="top" width="68.97%" headers="mcps1.3.2.2.4.2.1.2.3.1.2 "><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p48801043134312">Description of the API group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</p></li><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li33111754410"><span>Click <strong id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_b842352706164226">OK</strong>.</span><p><div class="p" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p15877110102719">After the API group is created, it is displayed in the API group list.<div class="note" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_note244319751817"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_ul188601320593"><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li12860113125918">The system automatically allocates a subdomain name to the API group for internal testing. The subdomain name can be accessed 1000 times a day.</li><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li6179142271711">A default API group is automatically generated for each dedicated gateway. APIs in the default group can be called using the IP address of the VPC where the dedicated gateway is deployed.</li><li id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_li2085720711593">To make your APIs available for users to access, bind independent domain names to the API group to which the APIs belong.</li></ul>
</div></div>
</div>
</p></li></ol>
</div>
<div class="section" id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_section12967127112416"><h4 class="sectiontitle">Follow-Up Operations</h4><p id="apig-en-ug-180307015__en-us_topic_0089184725_en-us_topic_0080101677_p108340533244">After the API group is created, bind independent domain names to it so that API callers can use the domain names to call APIs in the group. For more information, see <a href="apig-en-ug-180327076.html">Binding a Domain Name</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307014.html">API Group Management</a></div>
</div>
</div>

View File

@ -1,19 +0,0 @@
<a name="apig-en-ug-180307018"></a><a name="apig-en-ug-180307018"></a>
<h1 class="topictitle1">Deleting an API Group</h1>
<div id="body1511232545602"><div class="section" id="apig-en-ug-180307018__en-us_topic_0084753156_section1731012541118"><h4 class="sectiontitle">Scenario</h4><p id="apig-en-ug-180307018__en-us_topic_0084753156_p11880932707">You can delete an API group if you do not require it.</p>
<div class="note" id="apig-en-ug-180307018__en-us_topic_0084753156_note6930194614619"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-ug-180307018__en-us_topic_0084753156_p693064674614">API groups that contain APIs cannot be deleted.</p>
</div></div>
</div>
<div class="section" id="apig-en-ug-180307018__en-us_topic_0084753156_section83110548119"><h4 class="sectiontitle">Prerequisites</h4><p id="apig-en-ug-180307018__en-us_topic_0084753156_p884519147315">You have created an API group.</p>
</div>
<div class="section" id="apig-en-ug-180307018__en-us_topic_0084753156_section8731554122615"><h4 class="sectiontitle">Procedure</h4><ol id="apig-en-ug-180307018__en-us_topic_0084753156_ol43115541812"><li id="apig-en-ug-180307018__en-us_topic_0084753156_li1831115541819"><span>Log in to the management console.</span></li><li id="apig-en-ug-180307018__en-us_topic_0084753156_li46871818394"><span>In the navigation pane, choose <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b105334901317">Dedicated Gateways</strong>. Then click <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b95331491133">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apig-en-ug-180307018__en-us_topic_0084753156_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b842352706163622">API Publishing</strong> &gt; <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b842352706163624">API Groups</strong>.</span></li><li id="apig-en-ug-180307018__en-us_topic_0084753156_li459345519326"><span>Delete an API group. You can use one of the following methods:</span><p><ul id="apig-en-ug-180307018__en-us_topic_0084753156_ul659118555322"><li id="apig-en-ug-180307018__en-us_topic_0084753156_li174241428361">In the <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b101246912351">Operation</strong> column of the target API group, choose <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b84235270620348">More</strong> &gt; <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b842352706203416">Delete</strong>.</li><li id="apig-en-ug-180307018__en-us_topic_0084753156_li259118551323">Click the name of the target API group, and click <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b15891617163919">Delete Group</strong> in the upper right corner of the displayed API group details page.</li></ul>
</p></li><li id="apig-en-ug-180307018__en-us_topic_0084753156_li1353910714109"><span>Enter <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b842352706224818">DELETE</strong> and click <strong id="apig-en-ug-180307018__en-us_topic_0084753156_b1777164193212">Yes</strong>.</span></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307014.html">API Group Management</a></div>
</div>
</div>

View File

@ -1,31 +0,0 @@
<a name="apig-en-ug-180307019"></a><a name="apig-en-ug-180307019"></a>
<h1 class="topictitle1">API Management</h1>
<div id="body1508204232679"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="apig-en-ug-180307020.html">Creating an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180621094.html">CORS</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307025.html">Debugging an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307021.html">Authorizing Apps to Call an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307023.html">Publishing an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307024.html">Taking an API Offline</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-180307027.html">Deleting an API</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-181025104.html">Importing APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="apig-en-ug-181204105.html">Exporting APIs</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-ug-0008.html">API Opening</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -1,27 +0,0 @@
<a name="apig-en-ug-180307021"></a><a name="apig-en-ug-180307021"></a>
<h1 class="topictitle1">Authorizing Apps to Call an API</h1>
<div id="body1508204933192"><div class="section" id="apig-en-ug-180307021__en-us_topic_0080103324_section25971517509"><h4 class="sectiontitle">Scenario</h4><p id="apig-en-ug-180307021__en-us_topic_0080103324_p11880932707">APIs using app authentication can only be called by apps that have been authorized to call them.</p>
<div class="note" id="apig-en-ug-180307021__en-us_topic_0080103324_note11815124814279"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-en-ug-180307021__en-us_topic_0080103324_ul1761088123512"><li id="apig-en-ug-180307021__en-us_topic_0080103324_li061010815355">You can only authorize apps to call published APIs.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li1623411138356">You can authorize apps only to call APIs that use app authentication.</li></ul>
</div></div>
</div>
<div class="section" id="apig-en-ug-180307021__en-us_topic_0080103324_section1678010231609"><h4 class="sectiontitle">Prerequisites</h4><ul id="apig-en-ug-180307021__en-us_topic_0080103324_ul05200562619"><li id="apig-en-ug-180307021__en-us_topic_0080103324_li1452016502620">You have created an API group and API.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li181441893265">(Optional) You have created an environment.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li1016681712616">You have created an app.</li></ul>
</div>
<div class="section" id="apig-en-ug-180307021__en-us_topic_0080103324_section1942423018019"><h4 class="sectiontitle">Procedure</h4><ol id="apig-en-ug-180307021__en-us_topic_0080103324_ol43115541812"><li id="apig-en-ug-180307021__en-us_topic_0080103324_li1831115541819"><span>Log in to the management console.</span></li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li46871818394"><span>In the navigation pane, choose <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b152429112146">Dedicated Gateways</strong>. Then click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b824717110147">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b1467497151414">API Publishing</strong> &gt; <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b6675877144">APIs</strong>.</span></li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li1511540191420"><span>Authorize apps to call an API. You can use one of the following methods:</span><p><ul id="apig-en-ug-180307021__en-us_topic_0080103324_ul1469018231514"><li id="apig-en-ug-180307021__en-us_topic_0080103324_li369052111515">In the <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b095361911919">Operation</strong> column of the target API, choose <strong id="apig-en-ug-180307021__b325318487477">More</strong> &gt; <strong id="apig-en-ug-180307021__b202531748124718">Authorize App</strong>, and then click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b84235270614570">Select App</strong>.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li13337122132413">Select the target API, click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b82811561118">Authorize App</strong> over the API list, and then click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b6445143815423">Select App</strong>.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li116005921713">Authorize apps through the API details page.<ol type="a" id="apig-en-ug-180307021__en-us_topic_0080103324_ol65943915173"><li id="apig-en-ug-180307021__en-us_topic_0080103324_li659419914173">Click the name of the target API.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li15977343111720">Click the <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b84235270622571">Authorization</strong> tab.</li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li17177316131814">Click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b886018421421">Select App</strong>.</li></ol>
</li></ul>
<div class="note" id="apig-en-ug-180307021__en-us_topic_0080103324_note1840105117482"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-ug-180307021__en-us_topic_0080103324_p1840216517482">To authorize an app to access multiple APIs, select the APIs, and click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b1533613011125">Authorize App</strong>. Click <strong id="apig-en-ug-180307021__b960115897">Select App</strong>, select the app you wish to authorize, and click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b319124016127">OK</strong>. You can grant access to a maximum of 1000 APIs at a time.</p>
</div></div>
</p></li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li7717183225"><span>Select an environment, search for and select desired apps, and click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b1777734110289">OK</strong>.</span><p><p id="apig-en-ug-180307021__p027111286492"></p>
</p></li><li id="apig-en-ug-180307021__en-us_topic_0080103324_li183446711235"><span>After the authorization is complete, view the authorized apps on the <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b84235270623137">Authorization</strong> tab page or the <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b0747487596">Authorize App</strong> page.</span><p><div class="note" id="apig-en-ug-180307021__en-us_topic_0080103324_note1503158716"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-ug-180307021__en-us_topic_0080103324_p3504128719">If an app does not need to call the API, click <strong id="apig-en-ug-180307021__en-us_topic_0080103324_b75785532340">Cancel Authorization</strong> in the row containing the app to unbind it.</p>
</div></div>
</p></li></ol>
</div>
<div class="section" id="apig-en-ug-180307021__en-us_topic_0080103324_en-us_topic_0080101678_section1679143819506"><h4 class="sectiontitle">Follow-Up Operations</h4><p id="apig-en-ug-180307021__en-us_topic_0080103324_en-us_topic_0080101678_p1983541082215">After you authorize an app to call an API, the API can be called using SDKs of different programming languages.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307019.html">API Management</a></div>
</div>
</div>

View File

@ -1,34 +0,0 @@
<a name="apig-en-ug-180307023"></a><a name="apig-en-ug-180307023"></a>
<h1 class="topictitle1">Publishing an API</h1>
<div id="body1508204933192"><div class="section" id="apig-en-ug-180307023__en-us_topic_0080103325_section25971517509"><h4 class="sectiontitle">Scenario</h4><p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p11880932707">APIs can be called only after they have been published in an environment. You can publish APIs in different environments. APIG allows you to view the publication history (such as the version, description, time, and environment) of each API, and supports rollback of APIs to different historical versions.</p>
<div class="note" id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_note28910167376"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_ul14972161332"><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li114973161331">If you modify a published API, you must publish it again for the modifications to take effect in the environment in which the API has been published.</li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li18987161913315">A maximum of 10 publication records of an API are retained in an environment.</li></ul>
</div></div>
</div>
<div class="section" id="apig-en-ug-180307023__en-us_topic_0080103325_section1678010231609"><h4 class="sectiontitle">Prerequisites</h4><ul id="apig-en-ug-180307023__en-us_topic_0080103325_ul87051218123414"><li id="apig-en-ug-180307023__en-us_topic_0080103325_li670571814342">You have created an API group and API.</li><li id="apig-en-ug-180307023__en-us_topic_0080103325_li18733152143419">You have created an environment.</li></ul>
</div>
<div class="section" id="apig-en-ug-180307023__en-us_topic_0080103325_section1929412566340"><h4 class="sectiontitle">Publishing an API</h4><ol id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_ol43115541812"><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li1831115541819"><span>Log in to the management console.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li46871818394"><span>In the navigation pane, choose <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b2086748368">Dedicated Gateways</strong>. Then click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b9921481365">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li1311354012"><span>In the navigation pane, choose <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b16569515201117">API Publishing</strong> &gt; <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b5570151531117">APIs</strong>.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li63871220171114"><span>Publish an API. You can use one of the following methods:</span><p><ul id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_ul1826526191113"><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li13826182610112">Click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b176257432388">Publish</strong> in the row containing the API you want to publish.</li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li1232225181218">Click the name of the target API, and click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b446216143415">Publish</strong> in the upper right corner of the displayed API details page.</li></ul>
<div class="note" id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_note203219495211"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p1321249323">To publish multiple APIs, select the APIs, and click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b7551327163720">Publish</strong>. You can publish a maximum of 1000 APIs at a time.</p>
</div></div>
</p></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li17854113512"><span>Select the environment where the API will be published, and enter a description.</span><p><div class="note" id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_note358717343352"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_ul1228470354"><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li1122144723518">If the API has already been published in the environment, publishing it again will overwrite its definition in that environment.</li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li1665175012353">If there is no environment that meets your requirements, create a new one.</li></ul>
</div></div>
</p></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li38613145118"><span>Click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b84235270619227">Publish</strong>.</span></li></ol>
</div>
<div class="section" id="apig-en-ug-180307023__en-us_topic_0080103325_section10650536947"><h4 class="sectiontitle">Viewing Publication History</h4><ol id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_ol17705946133311"><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li77058465333"><span>Log in to the management console.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_li1281514123517"><span>In the navigation pane, choose <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b528433232120">Dedicated Gateways</strong>. Then click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b3284193272111">Access Console</strong> in the upper right corner of a dedicated gateway.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li15705146183311"><span>In the navigation pane, choose <strong id="apig-en-ug-180307023__b802270962">API Publishing</strong> &gt; <strong id="apig-en-ug-180307023__b860689650">APIs</strong>.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li09551541185519"><span>Click the name of the target API.</span></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li16744158021"><span>Click the <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b1162114120173">Publication History</strong> tab.</span><p><p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p9249797314">The publication history of the API is displayed.</p>
</p></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li101591281585"><span>Click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b08631564263">View Details</strong> in the <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b971861182711">Operation</strong> column of a version.</span><p><p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p20857133013812">The <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b578011315179">View Details</strong> dialog box displays the basic information, frontend and backend request information, input and constant parameters, parameter mappings, and example responses of the API.</p>
</p></li><li id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_li1768115181785"><span>To roll back the API to a historical version, click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b889210005518">Switch Version</strong> in the row containing the target version, and click <strong id="apig-en-ug-180307023__en-us_topic_0080103325_b158931306557">Yes</strong>.</span><p><p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p1422124112209">If "current version" is displayed next to the target version, the rollback was successful.</p>
<p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p1827323742018">When the API is called, configuration of the current version is used instead of the previously saved configuration.</p>
<p id="apig-en-ug-180307023__en-us_topic_0080103325_en-us_topic_0085245354_p1273737102014">For example, an API was published in the RELEASE environment on August 1, 2018. On August 20, 2018, the API was published in the same environment after modification. If the version published on August 1 is set as the current version, configuration of this version will be used when the API is called.</p>
</p></li></ol>
</div>
<div class="section" id="apig-en-ug-180307023__section528963134814"><h4 class="sectiontitle">FAQs About API Publishing</h4><p id="apig-en-ug-180307023__p12664345174817"><a href="apig-en-faq-180307002.html">Do I Need to Publish an API Again After Modification?</a></p>
<p id="apig-en-ug-180307023__p466534554810"><a href="apig-en-faq-180606011.html">Why Can't APIs Published in a Non-RELEASE Environment Be Accessed?</a></p>
<p id="apig-en-ug-180307023__p76651645184812"><a href="apig-en-faq-181016019.html">Can I Invoke Different Backend Services by Publishing an API in Different Environments?</a></p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="apig-en-ug-180307019.html">API Management</a></div>
</div>
</div>

Some files were not shown because too many files have changed in this diff Show More