Compare commits
110 Commits
fix_python
...
revert-mrs
| Author | SHA1 | Date | |
|---|---|---|---|
| c730abc06b | |||
| 465fa65574 | |||
| 950a183dfd | |||
| 7865008167 | |||
| d7efa23b27 | |||
| f10e68e36f | |||
| 48e8d8dff5 | |||
| 3b66ea69c4 | |||
| 77581a0230 | |||
| d55fd01a78 | |||
| a42c766ca4 | |||
| 3c9254d2ab | |||
| b92144f5c8 | |||
| 2eea95ac58 | |||
| 1aae9268b0 | |||
| e0076dd9e4 | |||
| 71d5c814e7 | |||
| 18fa519b3c | |||
| 6b0d0e47fa | |||
| eedb0dbf61 | |||
| bf386e4e89 | |||
| 096db143fc | |||
| 259125d2d2 | |||
| 048401a85e | |||
| 524d532476 | |||
| 0acd016099 | |||
| d48ac439de | |||
| 8edc7b7c8b | |||
| e27f3a1490 | |||
| c0b905b0d3 | |||
| ab3f905a00 | |||
| 1f5944ef64 | |||
| b1f896759f | |||
| 4ebc865775 | |||
| 62f76d6989 | |||
| da8877ec76 | |||
| 19668ae97b | |||
| 40dd670497 | |||
| 64e70217dd | |||
| e82406468b | |||
| af09635640 | |||
| f181b33195 | |||
| ce8b88bd41 | |||
| 4ee10e3166 | |||
| 95c0ef5cca | |||
| c96c8af9d3 | |||
| f463d397b5 | |||
| 193ee42159 | |||
| 177cd61a57 | |||
| 317d6d2384 | |||
| 6ae4b62d6f | |||
| 2b42b4ee5a | |||
| 97e27fde2b | |||
| a5e3903f6b | |||
| 7d82735858 | |||
| 12be926dd0 | |||
| d222507be1 | |||
| e856aa7145 | |||
| 5d7ef90c79 | |||
| 5aadd1c53e | |||
| e0d0a83c1f | |||
| cb6bbc4f03 | |||
| 7310adf178 | |||
| 1f548a024f | |||
| 5440a48253 | |||
| 2be04013dc | |||
| 3545bfdf29 | |||
| 2d12bcbbc6 | |||
| 27c370cc14 | |||
| 92dc761f6a | |||
| 41ce571d15 | |||
| 465341a1a9 | |||
| c18df8d8fe | |||
| c5d2d3b6dc | |||
| 13aa021d1d | |||
| 70ca474258 | |||
| 2d6f6839ae | |||
| be9eabe464 | |||
| ae6113b5ff | |||
| 44fe01a86a | |||
| f25a1833ed | |||
| bf0249500a | |||
| 0e899862f8 | |||
| 63188fad94 | |||
| 1e8f6c3012 | |||
| fdbbe7547a | |||
| 0e493ce804 | |||
| 0a1983aa72 | |||
| 6d1a64eb0a | |||
| 309de138ff | |||
| ebc8247e23 | |||
| 56ef54c8ee | |||
| 6c0ac1dd2f | |||
| 45c44093b9 | |||
| 0192fbb524 | |||
| 3fb78a3507 | |||
| ab5f2db011 | |||
| 843c771689 | |||
| bfc6e41869 | |||
| a199667b6c | |||
| 00b93aa0fa | |||
| 3a07c40729 | |||
| 6878ea6e04 | |||
| 233637c500 | |||
| 121e69b195 | |||
| 5bcedf0d10 | |||
| 2ced5c725f | |||
| ae0f134553 | |||
| a562174edd | |||
| 5020341264 |
@ -6,15 +6,13 @@
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0017.html">Querying Optional Anti-DDoS Defense Policies</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0018.html">Enabling Anti-DDoS</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0020.html">Querying Configured Anti-DDoS Defense Policies</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0021.html">Updating Anti-DDoS Defense Policies</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0022.html">Querying Anti-DDoS Tasks</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0023.html">Querying the List of Defense Statuses of EIPs</a></strong><br>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="antiddos_02_0024.html">Querying the Defense Status of a Specified EIP</a></strong><br>
|
||||
</li>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<a name="antiddos_02_0023"></a><a name="antiddos_02_0023"></a>
|
||||
|
||||
<h1 class="topictitle1">Querying the List of Defense Statuses of EIPs</h1>
|
||||
<h1 class="topictitle1">Querying the List of EIP Defense Statuses</h1>
|
||||
<div id="body25673664"><div class="section" id="antiddos_02_0023__section52441537"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0023__p66300913">This API enables you to query the defense statuses of all EIPs, regardless whether an EIP has been bound to an Elastic Cloud Server (ECS) or not.</p>
|
||||
</div>
|
||||
<div class="section" id="antiddos_02_0023__section2211792"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0023__ul1664874"><li id="antiddos_02_0023__li14983874">URI format<p id="antiddos_02_0023__p2328887145811"><a name="antiddos_02_0023__li14983874"></a><a name="li14983874"></a>GET /v1/{project_id}/antiddos</p>
|
||||
@ -147,7 +147,7 @@
|
||||
</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__p43298646">String</p>
|
||||
</td>
|
||||
<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>
|
||||
<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__parmvalue1230565076"><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__parmvalue477019951"><b>configuring</b></span>: indicates that defense is being configured.</li><li id="antiddos_02_0023__li53237738"><span class="parmvalue" id="antiddos_02_0023__parmvalue1131473574"><b>notConfig</b></span>: indicates that defense is not configured.</li><li id="antiddos_02_0023__li9377597"><span class="parmvalue" id="antiddos_02_0023__parmvalue1518160991"><b>packetcleaning</b></span>: indicates that traffic cleaning is underway.</li><li id="antiddos_02_0023__li17289511"><span class="parmvalue" id="antiddos_02_0023__parmvalue1660379527"><b>packetdropping</b></span>: indicates that traffic is discarded.</li></ul>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@ -179,6 +179,34 @@
|
||||
<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>
|
||||
<tr id="antiddos_02_0023__row5988647132316"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p13989134715236">traffic_pos_id</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__p129894474231">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__p119891947112314">Traffic triggering parameter</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="antiddos_02_0023__row02181153172311"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p52182532234">protect_capacity</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__p1521885320236">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__p16218155315233">Protection capacity. The value <span class="parmvalue" id="antiddos_02_0023__parmvalue395571616327"><b>0</b></span> indicates that protection is not supported.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="antiddos_02_0023__row466735117235"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p126671951172319">current_usage</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__p15667165111238">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__p1966717516233">Used protection capacity. The value <span class="parmvalue" id="antiddos_02_0023__parmvalue184968810381"><b>0</b></span> indicates that protection is not supported.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="antiddos_02_0023__row19843154911239"><td class="cellrowborder" valign="top" width="31.726827317268274%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0023__p2843249102314">enterprise_project_id</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__p118431549192315">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__p1884312499236">Enterprise project ID</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
@ -2,15 +2,25 @@
|
||||
|
||||
<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__b856695530">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__b620013998">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__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>
|
||||
<tbody><tr id="antiddos_02_0034__row19105101411014"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p21055144012">2025-01-21</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 class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><ul id="antiddos_02_0034__ul1157249104117"><li id="antiddos_02_0034__li15198215114211">Updated response parameters in <a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a>.</li><li id="antiddos_02_0034__li125725918414">Optimized the title of section <a href="antiddos_02_0023.html">Querying the List of EIP Defense Statuses</a>.</li><li id="antiddos_02_0034__li146331312416">Optimized the example request in <a href="antiddos_02_0037.html">Querying the Default Protection Policy Configured for the Newly Purchased Public IP Addresses</a>.</li><li id="antiddos_02_0034__li1931015515512">Optimized the example request in <a href="antiddos_02_0038.html">Configuring the Default Protection Policy for Newly Purchased Public IP Addresses</a>.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="antiddos_02_0034__row533003615444"><td class="cellrowborder" valign="top" width="27.33%" headers="mcps1.3.1.1.3.1.1 "><p id="antiddos_02_0034__p133314362446">2024-10-25</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="72.67%" headers="mcps1.3.1.1.3.1.2 "><p id="antiddos_02_0034__p2033143615443">Deleted section "Enabling Anti-DDoS".</p>
|
||||
</td>
|
||||
</tr>
|
||||
<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 in section "Querying the List of EIP Defense Statuses".</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>
|
||||
|
||||
@ -82,7 +82,7 @@
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="antiddos_02_0037__section11157820583"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0037__ul194081258134219"><li id="antiddos_02_0037__li6137121012436">Example request<pre class="codeblock" id="antiddos_02_0037__codeblock4650234015244">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default/config</pre>
|
||||
<div class="section" id="antiddos_02_0037__section11157820583"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0037__ul194081258134219"><li id="antiddos_02_0037__li6137121012436">Example request<pre class="codeblock" id="antiddos_02_0037__codeblock4650234015244">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default-config</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<ul id="antiddos_02_0037__ul01288818584"><li id="antiddos_02_0037__li212816816584">Example response<pre class="screen" id="antiddos_02_0037__screen13128198105819">{
|
||||
|
||||
@ -127,7 +127,7 @@
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="antiddos_02_0038__section1487315209019"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0038__ul25933367"><li id="antiddos_02_0038__li32073719">Example request<pre class="codeblock" id="antiddos_02_0038__codeblock6023557611459">POST /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default/config </pre>
|
||||
<div class="section" id="antiddos_02_0038__section1487315209019"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0038__ul25933367"><li id="antiddos_02_0038__li32073719">Example request<pre class="codeblock" id="antiddos_02_0038__codeblock6023557611459">POST /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/default-config </pre>
|
||||
<pre class="screen" id="antiddos_02_0038__screen43109556114535">{
|
||||
"enable_L7":true,
|
||||
"traffic_pos_id":1,
|
||||
|
||||
@ -289,7 +289,7 @@
|
||||
"node_id":"createenvironmentv2.xml",
|
||||
"product_code":"apig",
|
||||
"code":"16",
|
||||
"des":"API poviders can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request address",
|
||||
"des":"API providers can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request addres",
|
||||
"doc_type":"api",
|
||||
"kw":"Creating an Environment,Environment Management,API Reference",
|
||||
"search_title":"",
|
||||
@ -3267,7 +3267,7 @@
|
||||
"node_id":"createpostpayresizeorder.xml",
|
||||
"product_code":"apig",
|
||||
"code":"167",
|
||||
"des":"This API is used to creat a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid",
|
||||
"des":"This API is used to create a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpai",
|
||||
"doc_type":"api",
|
||||
"kw":"Modifying the Specifications of a Pay-Per-Use Gateway,Gateway Management,API Reference",
|
||||
"search_title":"",
|
||||
@ -4393,7 +4393,7 @@
|
||||
"node_id":"createappquota.xml",
|
||||
"product_code":"apig",
|
||||
"code":"224",
|
||||
"des":"Creating a Credential QuotaFor details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400Status code: 401Sta",
|
||||
"des":"This API is used to create a credential quota.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400",
|
||||
"doc_type":"api",
|
||||
"kw":"Creating a Credential Quota,Credential Quota Management,API Reference",
|
||||
"search_title":"",
|
||||
|
||||
@ -135,7 +135,7 @@
|
||||
"code":"15"
|
||||
},
|
||||
{
|
||||
"desc":"API poviders can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request address",
|
||||
"desc":"API providers can publish an API in different environments, such as the development, test, and production environmentsAPI information, such as the version, request addres",
|
||||
"product_code":"apig",
|
||||
"title":"Creating an Environment",
|
||||
"uri":"CreateEnvironmentV2.html",
|
||||
@ -1494,7 +1494,7 @@
|
||||
"code":"166"
|
||||
},
|
||||
{
|
||||
"desc":"This API is used to creat a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpaid",
|
||||
"desc":"This API is used to create a specification change order of a pay-per-use gateway.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/postpai",
|
||||
"product_code":"apig",
|
||||
"title":"Modifying the Specifications of a Pay-Per-Use Gateway",
|
||||
"uri":"CreatePostPayResizeOrder.html",
|
||||
@ -2007,7 +2007,7 @@
|
||||
"code":"223"
|
||||
},
|
||||
{
|
||||
"desc":"Creating a Credential QuotaFor details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400Status code: 401Sta",
|
||||
"desc":"This API is used to create a credential quota.For details, see Calling APIs.POST /v2/{project_id}/apigw/instances/{instance_id}/app-quotasStatus code: 201Status code: 400",
|
||||
"product_code":"apig",
|
||||
"title":"Creating a Credential Quota",
|
||||
"uri":"CreateAppQuota.html",
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="CreateAppQuota"></a><a name="CreateAppQuota"></a>
|
||||
|
||||
<h1 class="topictitle1">Creating a Credential Quota</h1>
|
||||
<div id="body55521934797"><div class="section" id="CreateAppQuota__section45538349918"><h4 class="sectiontitle">Function</h4><p id="CreateAppQuota__p2055318342914">Creating a Credential Quota</p>
|
||||
<div id="body55521934797"><div class="section" id="CreateAppQuota__section45538349918"><h4 class="sectiontitle">Function</h4><p id="CreateAppQuota__p15685145119193">This API is used to create a credential quota.</p>
|
||||
</div>
|
||||
<div class="section" id="CreateAppQuota__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="CreateAppQuota__p4553143416916">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="CreateEnvironmentV2"></a><a name="CreateEnvironmentV2"></a>
|
||||
|
||||
<h1 class="topictitle1">Creating an Environment</h1>
|
||||
<div id="body1533318115484"><div class="section" id="CreateEnvironmentV2__section933317184811"><h4 class="sectiontitle">Function</h4><p id="CreateEnvironmentV2__p83331118482">API poviders can publish an API in different environments, such as the development, test, and production environments</p>
|
||||
<div id="body1533318115484"><div class="section" id="CreateEnvironmentV2__section933317184811"><h4 class="sectiontitle">Function</h4><p id="CreateEnvironmentV2__p83331118482">API providers can publish an API in different environments, such as the development, test, and production environments</p>
|
||||
<p id="CreateEnvironmentV2__p113331219489">API information, such as the version, request address, and even request message, varies depending on the environment in which an API is published. For example, v1.0 of an API is published in the production environment, v1.1 in the test environment, and v1.2 in the development environment.</p>
|
||||
<p id="CreateEnvironmentV2__p633319119481">APIG provides environment management, enabling you to access APIG in different scenarios at minimal costs.</p>
|
||||
</div>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="CreatePostPayResizeOrder"></a><a name="CreatePostPayResizeOrder"></a>
|
||||
|
||||
<h1 class="topictitle1">Modifying the Specifications of a Pay-Per-Use Gateway</h1>
|
||||
<div id="body32001227"><div class="section" id="CreatePostPayResizeOrder__section557975281518"><h4 class="sectiontitle">Function</h4><p id="CreatePostPayResizeOrder__p7579185210159">This API is used to creat a specification change order of a pay-per-use gateway.</p>
|
||||
<div id="body32001227"><div class="section" id="CreatePostPayResizeOrder__section557975281518"><h4 class="sectiontitle">Function</h4><p id="CreatePostPayResizeOrder__p7579185210159">This API is used to create a specification change order of a pay-per-use gateway.</p>
|
||||
</div>
|
||||
<div class="section" id="CreatePostPayResizeOrder__en-us_topic_0000001929686677_atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="CreatePostPayResizeOrder__p1758095214157">For details, see <a href="apig-api-180713003.html">Calling APIs</a>.</p>
|
||||
</div>
|
||||
|
||||
@ -231,7 +231,7 @@
|
||||
"resource_name" : "apig_instance",
|
||||
"tags" : [ {
|
||||
"key" : "test-key",
|
||||
"value" : "test-vaue"
|
||||
"value" : "test-value"
|
||||
} ]
|
||||
}</pre>
|
||||
<p id="ListInstanceTags__p13940191714153"><strong id="ListInstanceTags__b194091791515">Status code: 401</strong></p>
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
||||
<div id="body8662426"><div class="section" id="apig-api-180713009__en-us_topic_0172449255_section414113577116"><h4 class="sectiontitle">Calling an API</h4><p id="apig-api-180713009__en-us_topic_0172449255_p184083580537">You can also obtain a project ID by calling the IAM API used to query project information.</p>
|
||||
<p id="apig-api-180713009__en-us_topic_0172449255_p82371314564">The API used to obtain a project ID is "GET https://<em id="apig-api-180713009__en-us_topic_0172449255_i756894312434">{Endpoint}</em>/v3/projects/". <em id="apig-api-180713009__en-us_topic_0172449255_i1555814694311">{Endpoint}</em> is the IAM endpoint and can be obtained from technical support. For details on API calling authentication, see <a href="apig-api-190529268.html#apig-api-190529268">Authentication</a>.</p>
|
||||
<p id="apig-api-180713009__en-us_topic_0172449255_p82371314564">The API used to obtain a project ID is "GET https://<em id="apig-api-180713009__i068742675213">{Endpoint}</em>/v3/projects/". <em id="apig-api-180713009__i14687162613527">{Endpoint}</em> is the IAM endpoint and can be obtained from technical support. For details on API calling authentication, see <a href="apig-api-190529268.html">Authentication</a>.</p>
|
||||
<p id="apig-api-180713009__en-us_topic_0172449255_p1461198134114">The following is an example response. The value of <strong id="apig-api-180713009__en-us_topic_0172449255_b3237123414241">id</strong> in the <strong id="apig-api-180713009__en-us_topic_0172449255_b7237143482412">projects</strong> field is the project ID.</p>
|
||||
<pre class="screen" id="apig-api-180713009__en-us_topic_0172449255_screen676419149446">{
|
||||
"projects": [
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<div class="section" id="apig-api-180713011__en-us_topic_0000001942519306_section1849899574"><h4 class="sectiontitle">Request URI</h4><p id="apig-api-180713011__en-us_topic_0000001942519306_p729531715312">A request URI is in the following format:</p>
|
||||
<p id="apig-api-180713011__en-us_topic_0000001942519306_p11610193811547"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b3129104565416">{URI-scheme} :// {<strong id="apig-api-180713011__en-us_topic_0000001942519306_b10231116812">Endpoint</strong>} / {resource-path} ? {query-string}</strong></p>
|
||||
<p id="apig-api-180713011__en-us_topic_0000001942519306_p19153141415558">Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.</p>
|
||||
<ul id="apig-api-180713011__en-us_topic_0000001942519306_ul63581757356"><li id="apig-api-180713011__en-us_topic_0000001942519306_li183581756359"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b83920310421">URI-scheme</strong>: Protocol used to transmit requests. All APIs use <strong id="apig-api-180713011__en-us_topic_0000001942519306_b539313114215">HTTPS</strong>.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li16358958354"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b13517165134215">Endpoint</strong>: Domain name or IP address of the server bearing the REST service. It can be obtained from <a href="apig-api-190529263.html#apig-api-190529263__en-us_topic_0000001969180093_section932113578479">Endpoints</a>. .</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li53597512351"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b31682350472">resource-path</strong>: Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the <strong id="apig-api-180713011__en-us_topic_0000001942519306_b1029107104914">resource-path</strong> of the API used to create an API group is <strong id="apig-api-180713011__en-us_topic_0000001942519306_b9304774916">/v2/</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i4302710494">{project_id}</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b19304718494">/apigw/instances/</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i730187124915">{instance_id}</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b7304744915">/api-groups</strong>. <em id="apig-api-180713011__en-us_topic_0000001942519306_i73010716494">{project_id}</em> indicates a <a href="apig-api-180713009.html#apig-api-180713009">project ID</a> and <em id="apig-api-180713011__en-us_topic_0000001942519306_i113027154915">{instance_id}</em> indicates a gateway ID. The two IDs can be obtained from the gateway information on the APIG console.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li735905103516"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b133601140195112">query-string</strong>: Query parameter, which is optional. Ensure that a question mark (?) is included in front of each query parameter that is in the format of <em id="apig-api-180713011__en-us_topic_0000001942519306_i1558345512518">Parameter name</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b1558425515110">=</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i10584105516516">Parameter value</em>. For example, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b458425545114">limit=10</strong> indicates that a maximum of 10 data records will be queried.</li></ul>
|
||||
<ul id="apig-api-180713011__en-us_topic_0000001942519306_ul63581757356"><li id="apig-api-180713011__en-us_topic_0000001942519306_li183581756359"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b83920310421">URI-scheme</strong>: Protocol used to transmit requests. All APIs use <strong id="apig-api-180713011__en-us_topic_0000001942519306_b539313114215">HTTPS</strong>.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li16358958354"><strong id="apig-api-180713011__b1799212564406">Endpoint</strong>: Domain name or IP address of the server bearing the REST service. It can be obtained from <a href="apig-api-190529263.html#apig-api-190529263__en-us_topic_0000001969180093_section932113578479">Endpoints</a>. .</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li53597512351"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b31682350472">resource-path</strong>: Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the <strong id="apig-api-180713011__b286407204117">resource-path</strong> of the API used to create an API group is <strong id="apig-api-180713011__b386419734117">/v2/</strong><em id="apig-api-180713011__i18643716412">{project_id}</em><strong id="apig-api-180713011__b18659716416">/apigw/instances/</strong><em id="apig-api-180713011__i18865167144111">{instance_id}</em><strong id="apig-api-180713011__b1686520715411">/api-groups</strong>. <em id="apig-api-180713011__i108651271419">{project_id}</em> indicates a <a href="apig-api-180713009.html">project ID</a> and <em id="apig-api-180713011__i1386517144110">{instance_id}</em> indicates a gateway ID. The two IDs can be obtained from the gateway information on the APIG console.</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li735905103516"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b133601140195112">query-string</strong>: Query parameter, which is optional. Ensure that a question mark (?) is included in front of each query parameter that is in the format of <em id="apig-api-180713011__en-us_topic_0000001942519306_i1558345512518">Parameter name</em><strong id="apig-api-180713011__en-us_topic_0000001942519306_b1558425515110">=</strong><em id="apig-api-180713011__en-us_topic_0000001942519306_i10584105516516">Parameter value</em>. For example, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b458425545114">limit=10</strong> indicates that a maximum of 10 data records will be queried.</li></ul>
|
||||
<p id="apig-api-180713011__en-us_topic_0000001942519306_p1766380168">For example, if you want to create an API group in a region, set <strong id="apig-api-180713011__en-us_topic_0000001942519306_b17584171219398">URI-scheme</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b3584141214395">HTTPS</strong>, <strong id="apig-api-180713011__en-us_topic_0000001942519306_b958451233915">Endpoint</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b12984148114020">apig_endpoint</strong>, and <strong id="apig-api-180713011__en-us_topic_0000001942519306_b10584712183911">resource-path</strong> to <strong id="apig-api-180713011__en-us_topic_0000001942519306_b115841012193914">/v2/{project_id}/apigw/instances/{instance_id}/api-groups</strong>. Combine the parameters in the URI.</p>
|
||||
<pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen439264613101">https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i16881440175117"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b198810405515">{apig_endpoint}</strong></em>/v2/{project_id}/apigw/instances/{instance_id}/api-groups</pre>
|
||||
<div class="note" id="apig-api-180713011__en-us_topic_0000001942519306_note16311253154112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-180713011__en-us_topic_0000001942519306_p163316534416">To simplify the URI display in this document, each API is provided only with a <strong id="apig-api-180713011__en-us_topic_0000001942519306_b762314910439">resource-path</strong> and a request method. The <strong id="apig-api-180713011__en-us_topic_0000001942519306_b6118813104315">URI-scheme</strong> of all APIs is <strong id="apig-api-180713011__en-us_topic_0000001942519306_b7120913164319">HTTPS</strong>, and the endpoints of all APIs in the same region are identical.</p>
|
||||
@ -29,7 +29,8 @@ Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-ty
|
||||
<p id="apig-api-180713011__en-us_topic_0000001942519306_p57506215250">Request bodies vary between APIs. Some APIs do not require the request body, such as the APIs requested using the <strong id="apig-api-180713011__en-us_topic_0000001942519306_b12519205617242">GET</strong> and <strong id="apig-api-180713011__en-us_topic_0000001942519306_b1953820586243">DELETE</strong> methods.</p>
|
||||
<p id="apig-api-180713011__en-us_topic_0000001942519306_p675014215258">For the API used to create an API group, you can obtain the request parameters and parameter description from the API request. Here is an example request that includes a body. The bold fields must be configured as required.</p>
|
||||
<ul id="apig-api-180713011__en-us_topic_0000001942519306_ul1558112914264"><li id="apig-api-180713011__en-us_topic_0000001942519306_li558192962612"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b10316276318">name</strong>: API group name</li><li id="apig-api-180713011__en-us_topic_0000001942519306_li125842952613"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b111225402313">remark</strong>: API group description</li></ul>
|
||||
<pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen6140617194816">POST https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i4324529339"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
|
||||
<pre class="screen" id="apig-api-180713011__en-us_topic_0000001942519306_screen6140617194816">
|
||||
POST https://<em id="apig-api-180713011__en-us_topic_0000001942519306_i4324529339"><strong id="apig-api-180713011__en-us_topic_0000001942519306_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
|
||||
Content-Type: application/json
|
||||
X-Sdk-Date: 20240416T095341Z
|
||||
Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************
|
||||
|
||||
@ -8,22 +8,10 @@
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="apig-api-180713215__row0928125381012"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p9929753111015">2024-12-13</p>
|
||||
<tbody><tr id="apig-api-180713215__row11493163410390"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p134941934173916">2024-12-10</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p29671349113">This issue incorporates the following changes:</p>
|
||||
<ul id="apig-api-180713215__ul228691913119"><li id="apig-api-180713215__li10286101917114">The example response status code of the API for modifying an app is changed from <strong id="apig-api-180713215__b1828661911114">201</strong> to <strong id="apig-api-180713215__b62866195115">200</strong>.</li><li id="apig-api-180713215__li13447181781414">The response status code of the API for modifying the specifications of a pay-per-use gateway is changed from <strong id="apig-api-180713215__b14270247181318">200</strong> to <strong id="apig-api-180713215__b18270194717138">202</strong>.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apig-api-180713215__row18722125144817"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p10723825164814">2024-12-10</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p36313432486">This issue incorporates the following changes:</p>
|
||||
<ul id="apig-api-180713215__ul42801253912"><li id="apig-api-180713215__li11280202513912">The response status code of the API for modifying an app is changed from <strong id="apig-api-180713215__b163764619482">201</strong> to <strong id="apig-api-180713215__b1673034814810">200</strong>.</li><li id="apig-api-180713215__li628010253919">The response body parameters table of the API for querying the supported features of a gateway is changed.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apig-api-180713215__row756664715318"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__p1956664715311">2024-10-18</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p161581162047">This issue incorporates the following changes:</p>
|
||||
<ul id="apig-api-180713215__ul3292105417413"><li id="apig-api-180713215__li229218541247">Updated <a href="apig-api-190529263.html">Before You Start</a>.</li><li id="apig-api-180713215__li129217549410">Optimized <a href="apig-api-180713003.html">Calling APIs</a>.</li><li id="apig-api-180713215__li7693195710420">Added <a href="apig-api-0001.html">API Usage</a>.</li></ul>
|
||||
<td class="cellrowborder" valign="top" width="70.67999999999999%" headers="mcps1.3.1.2.3.1.2 "><p id="apig-api-180713215__p19494193463911">This issue incorporates the following changes:</p>
|
||||
<ul id="apig-api-180713215__ul7811234691"><li id="apig-api-180713215__li19814342919">The response status code of the API for modifying an app is changed from 201 to 200.</li><li id="apig-api-180713215__li7810341998">The response body parameters table of the API for querying the supported features of a Gateway is changed.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apig-api-180713215__en-us_topic_0172451956_row19305205918129"><td class="cellrowborder" valign="top" width="29.32%" headers="mcps1.3.1.2.3.1.1 "><p id="apig-api-180713215__en-us_topic_0172451956_p4306175916123">2024-07-05</p>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
<div id="body8662426"><p id="apig-api-190529263__en-us_topic_0000001969180093_p14359124953115">API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps enterprises build, manage, and deploy APIs at any scale.</p>
|
||||
<p id="apig-api-190529263__en-us_topic_0000001969180093_p43591949123114">This document describes how to use REST APIs to perform operations on APIG, such as creating, deleting, and modify your own APIs. </p>
|
||||
<p id="apig-api-190529263__en-us_topic_0000001969180093_p33591494313">If you plan to access API Gateway through APIs, ensure that you are familiar with API Gateway concepts. For details, see the <em id="apig-api-190529263__en-us_topic_0000001969180093_i1287581820599">User Guide</em>.</p>
|
||||
<div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section932113578479"><h4 class="sectiontitle">Endpoints</h4><p id="apig-api-190529263__en-us_topic_0000001969180093_p14210164262711">An endpoint is the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b121007380415">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support engineers.</p>
|
||||
<div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section932113578479"><a name="apig-api-190529263__en-us_topic_0000001969180093_section932113578479"></a><a name="en-us_topic_0000001969180093_section932113578479"></a><h4 class="sectiontitle">Endpoints</h4><p id="apig-api-190529263__en-us_topic_0000001969180093_p14210164262711">An endpoint is the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b121007380415">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, contact technical support engineers.</p>
|
||||
</div>
|
||||
<div class="section" id="apig-api-190529263__en-us_topic_0000001969180093_section4575182612554"><h4 class="sectiontitle">Concepts</h4><ul id="apig-api-190529263__en-us_topic_0000001969180093_ul1351921410566"><li id="apig-api-190529263__en-us_topic_0000001969180093_li7519171455619">Account<p id="apig-api-190529263__en-us_topic_0000001969180093_p15520201418569"><a name="apig-api-190529263__en-us_topic_0000001969180093_li7519171455619"></a><a name="en-us_topic_0000001969180093_li7519171455619"></a>An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.</p>
|
||||
</li><li id="apig-api-190529263__en-us_topic_0000001969180093_li105201614195610">IAM user<p id="apig-api-190529263__en-us_topic_0000001969180093_p75201140563"><a name="apig-api-190529263__en-us_topic_0000001969180093_li105201614195610"></a><a name="en-us_topic_0000001969180093_li105201614195610"></a>A user is created using a domain to use cloud services. Each user has its own identity credentials (password and access keys).</p>
|
||||
@ -13,7 +13,7 @@
|
||||
<p id="apig-api-190529263__en-us_topic_0000001969180093_p85206147565">For details, see <span class="wintitle" id="apig-api-190529263__en-us_topic_0000001969180093_wintitle8100142544718"><b>Help Center > Others > FAQs > Regions and AZs</b></span>.</p>
|
||||
</li><li id="apig-api-190529263__en-us_topic_0000001969180093_li9520111405611">Availability zone (AZ)<p id="apig-api-190529263__en-us_topic_0000001969180093_p78805519575"><a name="apig-api-190529263__en-us_topic_0000001969180093_li9520111405611"></a><a name="en-us_topic_0000001969180093_li9520111405611"></a>An Availability Zone (AZ) contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, compute, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.</p>
|
||||
</li><li id="apig-api-190529263__en-us_topic_0000001969180093_li55206149566">Project<p id="apig-api-190529263__en-us_topic_0000001969180093_p95201914145618"><a name="apig-api-190529263__en-us_topic_0000001969180093_li55206149566"></a><a name="en-us_topic_0000001969180093_li55206149566"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.</p>
|
||||
<div class="fignone" id="apig-api-190529263__en-us_topic_0000001969180093_fig1152020149565"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="apig-api-190529263__en-us_topic_0000001969180093_image1656141374811" src="en-us_image_0000001988900321.png"></span></div>
|
||||
<div class="fignone" id="apig-api-190529263__en-us_topic_0000001969180093_fig1152020149565"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="apig-api-190529263__en-us_topic_0000001969180093_image1656141374811" src="en-us_image_0000002120347354.png"></span></div>
|
||||
<p id="apig-api-190529263__en-us_topic_0000001969180093_p102014374598">An IAM user can view the project ID on the <strong id="apig-api-190529263__en-us_topic_0000001969180093_b117851859161">My Credentials</strong> page of the console.</p>
|
||||
</li></ul>
|
||||
<ul id="apig-api-190529263__en-us_topic_0000001969180093_ul155211514145611"><li id="apig-api-190529263__en-us_topic_0000001969180093_li185211214125619">Enterprise project<p id="apig-api-190529263__en-us_topic_0000001969180093_p95211114175614"><a name="apig-api-190529263__en-us_topic_0000001969180093_li185211214125619"></a><a name="en-us_topic_0000001969180093_li185211214125619"></a>Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from enterprise projects.</p>
|
||||
|
||||
@ -4,29 +4,25 @@
|
||||
<div id="body8662426"><p id="apig-api-190529268__en-us_topic_0172440411_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:</p>
|
||||
<ul id="apig-api-190529268__en-us_topic_0172440411_ul38195410143846"><li id="apig-api-190529268__en-us_topic_0172440411_li61384639143846">AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it provides higher security than token-based authentication. </li><li id="apig-api-190529268__en-us_topic_0172440411_li8214375143846">Token-based authentication: Requests are authenticated using a token.<p id="apig-api-190529268__en-us_topic_0172440411_p97292269311"><a name="apig-api-190529268__en-us_topic_0172440411_li8214375143846"></a><a name="en-us_topic_0172440411_li8214375143846"></a></p>
|
||||
</li></ul>
|
||||
<div class="section" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"><h4 class="sectiontitle">AK/SK-based Authentication</h4><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p5607113161512">An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.</p>
|
||||
<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_n9dcbfe6b240a43cfa48bb67f6e4b0126"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_a9057158d9de6408fb6d7843353d9b3aa">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_a6b8f717e84924432b9b93893ca4141c1">SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</p>
|
||||
</div></div>
|
||||
<div class="section" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"><a name="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"></a><a name="en-us_topic_0172440411_en-us_topic_0121671869_section0390282152"></a><h4 class="sectiontitle">AK/SK-based Authentication</h4><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p5607113161512">An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests.</p>
|
||||
<ul id="apig-api-190529268__ul34615082010"><li id="apig-api-190529268__li1461206205">AK: access key ID, which is a unique identifier used with a secret access key to sign requests cryptographically.</li><li id="apig-api-190529268__li846119011206">SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</li></ul>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p15997957182616">The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p11261977377">Download the demo project at <a href="https://github.com/api-gate-way/SdkDemo" target="_blank" rel="noopener noreferrer">https://github.com/api-gate-way/SdkDemo</a>.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p19468322103716">If you do not need the demo, obtain the APIG signing SDK from technical support personnel.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p1656604461617">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</p>
|
||||
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig919329144115"><span class="figcap"><b>Figure 1 </b>Adding the APIG signing SDK</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image174116208156" src="en-us_image_0173593322.png"></span></div>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p1656604461617">Decompress the downloaded package and reference the obtained JAR file as a dependency.</p>
|
||||
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig919329144115"><span class="figcap"><b>Figure 1 </b>Adding the APIG signing SDK</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image174116208156" src="en-us_image_0000002155592541.png"></span></div>
|
||||
<ol id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol18692431181510"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li039995792416"><span>Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be <strong id="apig-api-190529268__en-us_topic_0172440411_b208892054103419">credentials.csv</strong>.)</span><p><ol type="a" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol1041165715248"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li641635711249">Register an account and log in to the management console.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li15426115710241">Hover over the username and choose <strong id="apig-api-190529268__en-us_topic_0172440411_b1331310311386">My Credentials</strong> from the drop-down list.</li></ol><ol type="a" start="3" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol4435175711246"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li94401457192414">Choose <strong id="apig-api-190529268__en-us_topic_0172440411_b6484124314610">Access Keys</strong> from the navigation pane.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li4446115712243">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b1766935216311">Create Access Key</strong>.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1645475712241">Enter the login password.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li546365716247">Enter the verification code received by email or SMS message.<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_note12481175762411"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p249925712416">For users created in IAM that have not bound any email address or mobile number, only the login password needs to be entered.</p>
|
||||
</div></div>
|
||||
</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li20543057142412">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b114935414311">OK</strong> to download the access key.<div class="note" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_note35511957122417"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p3570155782420">Keep the access key secure.</p>
|
||||
</div></div>
|
||||
</li></ol>
|
||||
</p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1115311720450"><span>Download and decompress the demo project.</span></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"><a name="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><a name="en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><span>Import the demo project to Eclipse.</span><p><div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig16546145205014"><span class="figcap"><b>Figure 2 </b>Selecting Existing Projects into Workspace</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image1474131114720" src="en-us_image_0173593323.png"></span></div>
|
||||
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig767232218519"><span class="figcap"><b>Figure 3 </b>Selecting the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image13419842205018" src="en-us_image_0173593324.png"></span></div>
|
||||
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig159778103242"><span class="figcap"><b>Figure 4 </b>Structure of the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image128044312389" src="en-us_image_0173593326.png"></span></div>
|
||||
</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li20543057142412">Click <strong id="apig-api-190529268__en-us_topic_0172440411_b114935414311">OK</strong> to download the access key. <strong id="apig-api-190529268__b6767153815544">Keep the access key secure.</strong></li></ol>
|
||||
</p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1115311720450"><span>Download and decompress the demo project.</span></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"><a name="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><a name="en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214"></a><span>Import the demo project to Eclipse.</span><p><div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig16546145205014"><span class="figcap"><b>Figure 2 </b>Selecting Existing Projects into Workspace</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image1474131114720" src="en-us_image_0000002120352414.png"></span></div>
|
||||
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig767232218519"><span class="figcap"><b>Figure 3 </b>Selecting the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image13419842205018" src="en-us_image_0000002120194306.png"></span></div>
|
||||
<div class="fignone" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_fig159778103242"><span class="figcap"><b>Figure 4 </b>Structure of the demo project</span><br><span><img id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_image128044312389" src="en-us_image_0000002155714161.png"></span></div>
|
||||
</p></li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li878093111517"><span>Sign the request.</span><p><p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p10940124322710">The request signing method is integrated in the JAR files imported in <a href="#apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li19564155663214">3</a>. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p979243115158">The demo code is classified into the following classes to demonstrate signing and sending the HTTP request:</p>
|
||||
<ul id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ul46077243144336"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li373103144336"><strong id="apig-api-190529268__en-us_topic_0172440411_b118932035103413">AccessService</strong>: an abstract class that merges the GET, POST, PUT, and DELETE methods into the access method.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li15119103144339"><strong id="apig-api-190529268__en-us_topic_0172440411_b199517574414">Demo</strong>: Execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests.</li><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li54381430144341"><strong id="apig-api-190529268__en-us_topic_0172440411_b739815754210">AccessServiceImpl</strong>: Implements the access method, which contains the code required for communication with APIG.</li></ul>
|
||||
<ol type="a" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_ol1515318170459"><li id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_li1985133317503">Edit the main() method in the <strong id="apig-api-190529268__en-us_topic_0172440411_b1644717515392">Demo.java</strong> file, and replace the bold text with actual values.<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p2061535616161">As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p129401344175213">Specify <strong id="apig-api-190529268__en-us_topic_0172440411_b2642123633911">region</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b7960183753910">serviceName</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b7975103917398">ak/sk</strong>, and <strong id="apig-api-190529268__en-us_topic_0172440411_b12744542143916">url</strong> as the actual values. In this demo, the URLs for accessing VPC resources are used.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p27531945173720">To obtain the project ID in the URLs, see <a href="apig-api-180713009.html#apig-api-180713009">Obtaining a Project ID</a>. To obtain the endpoint, contact the enterprise administrator.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_p27531945173720">To obtain the project ID in the URLs, see <a href="apig-api-180713009.html">Obtaining a Project ID</a>. To obtain the endpoint, contact the enterprise administrator.</p>
|
||||
<pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_screen89816540225">//<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b6201155152216">TODO</strong>: Replace region with the name of the region in which the service to be accessed is located.
|
||||
<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b17211255162214">private</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b152115532218">static</strong> <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b1121105522215">final</strong> String <strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_b5213558226"><em id="apig-api-190529268__en-us_topic_0172440411_en-us_topic_0121671869_i2211455112218">region</em></strong> = "";
|
||||
|
||||
@ -70,10 +66,10 @@ String url = "<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic
|
||||
</li></ol>
|
||||
</p></li></ol>
|
||||
</div>
|
||||
<div class="section" id="apig-api-190529268__en-us_topic_0172440411_section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="note" id="apig-api-190529268__en-us_topic_0172440411_note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apig-api-190529268__en-us_topic_0172440411_ul1811111515204"><li id="apig-api-190529268__en-us_topic_0172440411_li515275492018">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</li><li id="apig-api-190529268__en-us_topic_0172440411_li1111051162020">Ensure that the token is valid when you use it. Using a token that will soon expire may cause API calling failures.</li></ul>
|
||||
<div class="section" id="apig-api-190529268__en-us_topic_0172440411_section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="notice" id="apig-api-190529268__note184901082218"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><ul id="apig-api-190529268__en-us_topic_0172440411_ul1811111515204"><li id="apig-api-190529268__en-us_topic_0172440411_li515275492018">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</li><li id="apig-api-190529268__en-us_topic_0172440411_li1111051162020">Ensure that the token is valid when you use it. Using a token that will soon expire may cause API calling failures.</li></ul>
|
||||
</div></div>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p18703477214">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p7715203712228">When calling an API to obtain a user token, you must set <strong id="apig-api-190529268__en-us_topic_0172440411_b15281131314375">auth.scope</strong> in the request body to <strong id="apig-api-190529268__en-us_topic_0172440411_b16667169193710">project</strong>.</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p7715203712228">When calling an API to obtain a user token, you must set <strong id="apig-api-190529268__b1699975817464">auth.scope</strong> in the request body to <strong id="apig-api-190529268__b6045917468">project</strong>.</p>
|
||||
<pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_screen771517374228">{
|
||||
"auth": {
|
||||
"identity": {
|
||||
@ -97,11 +93,11 @@ String url = "<strong id="apig-api-190529268__en-us_topic_0172440411_en-us_topic
|
||||
<strong id="apig-api-190529268__en-us_topic_0172440411_b1071633722218"> }</strong>
|
||||
}
|
||||
}</pre>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p9691122114266">After a token is obtained, the <strong id="apig-api-190529268__en-us_topic_0172440411_b1989511293228">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <strong id="apig-api-190529268__en-us_topic_0172440411_b557119459221">ABCDEFJ....</strong>, <strong id="apig-api-190529268__en-us_topic_0172440411_b15689948152216">X-Auth-Token: ABCDEFJ....</strong> can be added to a request as follows:</p>
|
||||
<p id="apig-api-190529268__en-us_topic_0172440411_p9691122114266">After a token is obtained, the <strong id="apig-api-190529268__en-us_topic_0172440411_b1989511293228">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <span class="parmvalue" id="apig-api-190529268__parmvalue151511509464"><b>ABCDEFG....</b></span>, <span class="parmvalue" id="apig-api-190529268__parmvalue11511407462"><b>X-Auth-Token: ABCDEFG....</b></span> can be added to a request as follows:</p>
|
||||
<pre class="screen" id="apig-api-190529268__en-us_topic_0172440411_screen11189101154015">
|
||||
POST https://<em id="apig-api-190529268__en-us_topic_0172440411_i4324529339"><strong id="apig-api-190529268__en-us_topic_0172440411_b2325192915318">{apig_endpoint}</strong></em>/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
|
||||
Content-Type: application/json
|
||||
<strong id="apig-api-190529268__en-us_topic_0172440411_b172853338430">X-Auth-Token: ABCDEFJ....</strong></pre>
|
||||
<strong id="apig-api-190529268__en-us_topic_0172440411_b172853338430">X-Auth-Token: ABCDEFG....</strong></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
|
||||
@ -2,12 +2,12 @@
|
||||
|
||||
<h1 class="topictitle1">Response</h1>
|
||||
<div id="body8662426"><p id="apig-api-190529269__en-us_topic_0172440412_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
|
||||
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="apig-api-190529269__en-us_topic_0172440412_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="apig-api-180713206.html#apig-api-180713206">HTTP Status Codes</a>.</p>
|
||||
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="apig-api-190529269__en-us_topic_0172440412_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="apig-api-180713206.html">HTTP Status Codes</a>.</p>
|
||||
<p id="apig-api-190529269__en-us_topic_0172440412_p2861496519">For example, if status code <strong id="apig-api-190529269__en-us_topic_0172440412_b1944618526549">201</strong> is returned for calling the API used to create an API group, the request is successful.</p>
|
||||
</div>
|
||||
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="apig-api-190529269__en-us_topic_0172440412_p384320471837">Similar to a request, a response also has a header, for example, <strong id="apig-api-190529269__en-us_topic_0172440412_b3428039105210">Content-Type</strong>.</p>
|
||||
<p id="apig-api-190529269__en-us_topic_0172440412_p586212517238">For example, when calling the API used to create an API group (dedicated gateways), the response headers are shown below.</p>
|
||||
<div class="fignone" id="apig-api-190529269__en-us_topic_0172440412_fig11253355175215"><span class="figcap"><b>Figure 1 </b>Response headers for creating an API group</span><br><span><img id="apig-api-190529269__en-us_topic_0172440412_image4904194084419" src="en-us_image_0000001892790552.png"></span></div>
|
||||
<div class="fignone" id="apig-api-190529269__en-us_topic_0172440412_fig11253355175215"><span class="figcap"><b>Figure 1 </b>Response headers for creating an API group</span><br><span><img id="apig-api-190529269__en-us_topic_0172440412_image4904194084419" src="en-us_image_0000002155592549.png"></span></div>
|
||||
</div>
|
||||
<div class="section" id="apig-api-190529269__en-us_topic_0172440412_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="apig-api-190529269__en-us_topic_0172440412_p133921631940">The body of a response is often returned in structured format as specified in the <strong id="apig-api-190529269__en-us_topic_0172440412_b205653394539">Content-Type</strong> header field. The response body transfers content except the response header.</p>
|
||||
<p id="apig-api-190529269__en-us_topic_0172440412_p157041652367">The following is part of the response body for the API used to create an API group.</p>
|
||||
|
||||
@ -1,8 +1,11 @@
|
||||
<a name="apig-api-190529271"></a><a name="apig-api-190529271"></a>
|
||||
|
||||
<h1 class="topictitle1">Appendix</h1>
|
||||
<div id="body8662426"><p id="apig-api-190529271__en-us_topic_0172449253_p8060118"></p>
|
||||
|
||||
<h1 class="topictitle1">Appendix</h1>
|
||||
|
||||
<div id="body8662426"><p id="apig-api-190529271__en-us_topic_0172449253_p8060118"></p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="apig-api-180713204.html">Pagination Query</a></strong><br>
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="apig-api-20200402"></a><a name="apig-api-20200402"></a>
|
||||
|
||||
<h1 class="topictitle1">Supported Features</h1>
|
||||
<div id="body32001227"><p id="apig-api-20200402__en-us_topic_0000001143328897_p207271902710">The following table lists the features that are supported by <strong id="apig-api-20200402__en-us_topic_0000001143328897_b105351432182619">dedicated gateways</strong>.</p>
|
||||
<div id="body8662426"><p id="apig-api-20200402__en-us_topic_0000001143328897_p207271902710">The following table lists the features that are supported by <strong id="apig-api-20200402__en-us_topic_0000001143328897_b105351432182619">dedicated gateways</strong>.</p>
|
||||
<div class="note" id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_note34931951184916"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p1749305104912">If the gateway you use does not have specific features, contact technical support to upgrade your gateway.</p>
|
||||
</div></div>
|
||||
|
||||
@ -25,7 +25,7 @@
|
||||
</thead>
|
||||
<tbody><tr id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_row128492810369"><td class="cellrowborder" rowspan="4" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p1029016288362">lts</p>
|
||||
</td>
|
||||
<td class="cellrowborder" rowspan="4" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p12901282361">Reporting of Shubao access logs</p>
|
||||
<td class="cellrowborder" rowspan="4" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p12901282361">Reporting of APIG gateway node access logs</p>
|
||||
</td>
|
||||
<td class="cellrowborder" rowspan="4" valign="top" width="10.99109910991099%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20200402__en-us_topic_0000001143328897_en-us_topic_0281057028_p936943354616">Yes</p>
|
||||
</td>
|
||||
@ -836,23 +836,6 @@
|
||||
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p20776164115815">-</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apig-api-20200402__en-us_topic_0000001143328897_row153455296504"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p16184017514">sm_cipher_type</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p8182025118">Encrypting local sensitive data with commercial cryptographic algorithms</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="10.99109910991099%" headers="mcps1.3.3.1.9.1.3 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p018180145110">No</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.901290129012901%" headers="mcps1.3.3.1.9.1.4 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p9973174425816">-</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.241224122412241%" headers="mcps1.3.3.1.9.1.5 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p109732044145819">-</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.281428142814285%" headers="mcps1.3.3.1.9.1.6 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p1597311441582">-</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.151215121512152%" headers="mcps1.3.3.1.9.1.7 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p59733449587">-</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="13.211321132113213%" headers="mcps1.3.3.1.9.1.8 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p129731544165820">-</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apig-api-20200402__en-us_topic_0000001143328897_row10178836505"><td class="cellrowborder" valign="top" width="13.671367136713672%" headers="mcps1.3.3.1.9.1.1 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p11189012510">rate_limit_algorithm</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="10.551055105510551%" headers="mcps1.3.3.1.9.1.2 "><p id="apig-api-20200402__en-us_topic_0000001143328897_p21816018513">Request throttling algorithm switchover</p>
|
||||
|
||||
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 274 KiB After Width: | Height: | Size: 274 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 90 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
@ -98,7 +98,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.7.3.2.5.1.2 "><p id="apig-en-api-180328002__p363011371216">Type (or format) of the message body.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.7.3.2.5.1.3 "><p id="apig-en-api-180328002__p1263043712111">Mandatory</p>
|
||||
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.7.3.2.5.1.3 "><p id="apig-en-api-180328002__p1263043712111">Mandatory if the request body is available.</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="34%" headers="mcps1.3.7.3.2.5.1.4 "><p id="apig-en-api-180328002__p13630183715110">application/json</p>
|
||||
</td>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<div class="section" id="apig-en-api-180328003__section3546598312249"><h4 class="sectiontitle">Procedure</h4><ol id="apig-en-api-180328003__ol5417235112249"><li id="apig-en-api-180328003__li7201450105021">Send <strong id="apig-en-api-180328003__b034312224917">POST https://</strong><em id="apig-en-api-180328003__i20265928093">IAM endpoint</em><strong id="apig-en-api-180328003__b1356462520912">/v3/auth/tokens</strong> to obtain the IAM endpoint and the region name in the message body.<p id="apig-en-api-180328003__p29157503105024">See <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
||||
<p id="apig-en-api-180328003__p126473211266"></p>
|
||||
<p id="apig-en-api-180328003__p066712334263">A cloud service can be deployed globally or at the project level.</p>
|
||||
<ul id="apig-en-api-180328003__ul11667123332614"><li id="apig-en-api-180328003__li17667173382616">A project-level service requires a project-level token. When you call the API, set <strong id="apig-en-api-180328003__b18431516468">auth.scope</strong> in the request body to <strong id="apig-en-api-180328003__b5845158464">project</strong>. The following services are at the project level: AOM, APIG, AS, BMS, CBR, CCE, Cloud Eye, CSBS, CSS, CTS, DataArts Studio, DC, DCS, DDS, Dedicated WAF, DeH, DIS, DLI, DMS, DNS, DRS, DWS, ECS, EIP, ELB, EVS, GaussDB (for MySQL), GaussDB NoSQL, IMS, KMS, LTS, ModelArts, MRS, NAT, PLAS, RDS, RTS, SDRS, SFS, SMN, SWR, VBS, VPC, VPCEP, VPN, and WAF.</li><li id="apig-en-api-180328003__li7667233182615">A global service requires a global token. When you call the API, set <strong id="apig-en-api-180328003__b16642105915485">auth.scope</strong> in the request body to <strong id="apig-en-api-180328003__b364265915485">domain</strong>. The following services are global ones: Anti-DDoS, IAM, OBS, TMS, and TMS.</li></ul>
|
||||
<ul id="apig-en-api-180328003__ul11667123332614"><li id="apig-en-api-180328003__li17667173382616">A project-level service requires a project-level token. When you call the API, set <strong id="apig-en-api-180328003__b18431516468">auth.scope</strong> in the request body to <strong id="apig-en-api-180328003__b5845158464">project</strong>. The following services are at the project level: AOM, APIG, AS, BMS, CBR, CCE, Cloud Eye, CSBS, CSS, CTS, DataArts Studio, DC, DCS, DDS, Dedicated WAF, DeH, DIS, DLI, DMS, DNS, DRS, DWS, ECS, EIP, ELB, EVS, GaussDB (for MySQL), GaussDB NoSQL, IMS, KMS, LTS, ModelArts, MRS, NAT, PLAS, RDS, RTS, SDRS, SFS, SMN, SWR, VBS, VPC, VPCEP, VPN, and WAF.</li><li id="apig-en-api-180328003__li7667233182615">A global service requires a global token. When you call the API, set <strong id="apig-en-api-180328003__b16642105915485">auth.scope</strong> in the request body to <strong id="apig-en-api-180328003__b364265915485">domain</strong>. The following services are global ones: Anti-DDoS, IAM, OBS, and TMS.</li></ul>
|
||||
<div class="p" id="apig-en-api-180328003__p4434491412249">The following shows an example of a project-level service request:<div class="note" id="apig-en-api-180328003__note6355990812249"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apig-en-api-180328003__p3516826412249">Replace the texts in italic with actual ones. For details, see <em id="apig-en-api-180328003__i842352697155127">Identity and Access Management API Reference</em>.</p>
|
||||
<p id="apig-en-api-180328003__p1770474713271">Log in to the management console, click your username in the upper right corner, and choose <strong id="apig-en-api-180328003__b1424175514817">My Credential</strong> from the drop-down list. On the <strong id="apig-en-api-180328003__b362886114912">My Credentials</strong> page, obtain your username, domain name, and project ID.</p>
|
||||
</div></div>
|
||||
@ -19,17 +19,17 @@
|
||||
],
|
||||
"password": {
|
||||
"user": {
|
||||
"name": "<em id="apig-en-api-180328003__i3005717212249"><strong id="apig-en-api-180328003__b34061845415">username</strong></em>", // IAM username
|
||||
"password": "<em id="apig-en-api-180328003__i207909212249"><strong id="apig-en-api-180328003__b626512207546">password</strong></em>", // IAM user password
|
||||
"name": "<em id="apig-en-api-180328003__i125911951089"><strong id="apig-en-api-180328003__b859115511887">username</strong></em>", // IAM username
|
||||
"password": "<em id="apig-en-api-180328003__i117865571283"><strong id="apig-en-api-180328003__b1578616572817">password</strong></em>", // IAM user password
|
||||
"domain": {
|
||||
"name": "<em id="apig-en-api-180328003__i1871183512249"><strong id="apig-en-api-180328003__b7805102111542">domainname</strong></em>" // Name of the domain to which the IAM user belongs
|
||||
"name": "<em id="apig-en-api-180328003__i38391959918"><strong id="apig-en-api-180328003__b10839165494">domainname</strong></em>" // Name of the domain to which the IAM user belongs
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scope": {
|
||||
"<strong id="apig-en-api-180328003__b563015402144">project</strong>": {
|
||||
"id": "<strong id="apig-en-api-180328003__b4301132835416"><em id="apig-en-api-180328003__i1191627165415">0215ef11e49d4743be23dd97a1561e91</em></strong>" // Project ID
|
||||
"id": "<strong id="apig-en-api-180328003__b3151410294"><em id="apig-en-api-180328003__i6156101991">0215ef11e49d4743be23dd97a1561e91</em></strong>" // Project ID
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -44,17 +44,17 @@
|
||||
],
|
||||
"password": {
|
||||
"user": {
|
||||
"name": "<em id="apig-en-api-180328003__i1589423111011"><strong id="apig-en-api-180328003__b1589423112012">username</strong></em>", // IAM username
|
||||
"password": "<em id="apig-en-api-180328003__i7932938307"><strong id="apig-en-api-180328003__b149328381909">password</strong></em>", // IAM user password
|
||||
"name": "<em id="apig-en-api-180328003__i160716171910"><strong id="apig-en-api-180328003__b760714172911">username</strong></em>", // IAM username
|
||||
"password": "<em id="apig-en-api-180328003__i24551321391"><strong id="apig-en-api-180328003__b10455021891">password</strong></em>", // IAM user password
|
||||
"domain": {
|
||||
"name": "<em id="apig-en-api-180328003__i34335451306"><strong id="apig-en-api-180328003__b343319451304">domainname</strong></em>" // Name of the domain to which the IAM user belongs
|
||||
"name": "<em id="apig-en-api-180328003__i762311251092"><strong id="apig-en-api-180328003__b36236251096">domainname</strong></em>" // Name of the domain to which the IAM user belongs
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scope": {
|
||||
"<strong id="apig-en-api-180328003__b191917362143">domain</strong>": {
|
||||
"name": "<em id="apig-en-api-180328003__i13403382119"><strong id="apig-en-api-180328003__b74031884120">domainname</strong></em>" // Name of the domain to which the IAM user belongs
|
||||
"name": "<em id="apig-en-api-180328003__i1942319308914"><strong id="apig-en-api-180328003__b154231330493">domainname</strong></em>" // Name of the domain to which the IAM user belongs
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -48,7 +48,7 @@
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<ol id="apm_01_0002__en-us_topic_0000001195565132_ol20487111016266"><li id="apm_01_0002__en-us_topic_0000001195565132_li11487171062616">Access to APM: Applications need to implement AK/SK authentication to connect to APM.</li><li id="apm_01_0002__en-us_topic_0000001195565132_li348714108269">O&M data collection: APM can collect data about applications, basic resources, and user experience from Agents in non-intrusive mode.</li><li id="apm_01_0002__en-us_topic_0000001195565132_li13335281588">Service implementation: APM supports application metric monitoring, application topology, tracing, and intelligent alarm reporting.</li><li id="apm_01_0002__en-us_topic_0000001195565132_li11487181012612">Service expansion:<ul id="apm_01_0002__en-us_topic_0000001195565132_ul539681181414"><li id="apm_01_0002__en-us_topic_0000001195565132_li839619110147">You can quickly diagnose application performance exceptions based on the application topology and tracing of APM, and make judgments based on the application O&M metrics of Application Operations Management (AOM).</li><li id="apm_01_0002__en-us_topic_0000001195565132_li919713571510">Based on the historical metric data learned by using intelligent algorithms, APM associates metrics for analysis from multiple dimensions, extracts the context data of both normal and abnormal services for comparison, and locates root causes through cluster analysis.</li></ul>
|
||||
<ol id="apm_01_0002__en-us_topic_0000001195565132_ol20487111016266"><li id="apm_01_0002__en-us_topic_0000001195565132_li11487171062616">Access to APM: Applications need to implement AK/SK authentication to connect to APM.</li><li id="apm_01_0002__en-us_topic_0000001195565132_li348714108269">O&M data collection: APM can collect data about applications, basic resources, and user experience from Agents in non-intrusive mode.</li><li id="apm_01_0002__en-us_topic_0000001195565132_li13335281588">Service implementation: APM supports application metric monitoring, application topology, tracing, and intelligent alarm reporting.</li><li id="apm_01_0002__en-us_topic_0000001195565132_li11487181012612">Service expansion:<ul id="apm_01_0002__en-us_topic_0000001195565132_ul539681181414"><li id="apm_01_0002__en-us_topic_0000001195565132_li839619110147">You can quickly diagnose application performance exceptions based on the application topology and tracing of APM, and make judgments based on the application O&M metrics of Application Operations Management (AOM).</li><li id="apm_01_0002__en-us_topic_0000001195565132_li919713571510">APM uses intelligent algorithms to learn historical metric data. It can then associate metrics for analysis from multiple dimensions, extract the context data of both normal and abnormal services for comparison, and locate root causes through cluster analysis.</li></ul>
|
||||
</li></ol>
|
||||
</div>
|
||||
<div class="section" id="apm_01_0002__en-us_topic_0000001195565132_section890022319284"><h4 class="sectiontitle">Advantages</h4><p id="apm_01_0002__en-us_topic_0000001195565132_p690022316288"><span><img id="apm_01_0002__en-us_topic_0000001195565132_image7234016175415" src="en-us_image_0000001278522953.png"></span></p>
|
||||
|
||||
@ -2,7 +2,8 @@
|
||||
|
||||
<h1 class="topictitle1">Functions</h1>
|
||||
<div id="body8662426"><p id="apm_01_0003__en-us_topic_0000001195725120_a29547e649dec42d0aa22f42b2a46e98f">APM manages cloud application performance. It provides application metric monitoring, tracing, application topology, URL tracing, intelligent alarm reporting, tag/Agent/configuration/system management, and application monitoring.</p>
|
||||
<div class="section" id="apm_01_0003__en-us_topic_0000001195725120_section87847237262"><h4 class="sectiontitle">Application Metric Monitoring</h4><p id="apm_01_0003__en-us_topic_0000001195725120_p18561034192613">This function enables you to monitor the overall health status of applications. APM Agents collect metrics of JVM, GC, service calls, exceptions, external calls, database access, and middleware of Java applications, helping you monitor application running.</p>
|
||||
<div class="section" id="apm_01_0003__en-us_topic_0000001195725120_section87847237262"><h4 class="sectiontitle">Application Metric Monitoring</h4><p id="apm_01_0003__en-us_topic_0000001195725120_p202921707236">This function enables you to monitor the overall health status of applications. It includes application monitoring details, application monitoring settings, monitoring item views, instances, collection status, and component settings.</p>
|
||||
<ul id="apm_01_0003__en-us_topic_0000001195725120_ul112206342249"><li id="apm_01_0003__en-us_topic_0000001195725120_li20220134152410">Application monitoring details: APM Agents collect metrics of JVM, GC, service calls, exceptions, external calls, database access, and middleware of Java applications to help you monitor their conditions.</li><li id="apm_01_0003__en-us_topic_0000001195725120_li1267213119255">Application monitoring settings: You can customize collection parameters for some collectors.</li><li id="apm_01_0003__en-us_topic_0000001195725120_li165001364255">Monitoring item views: APM supports summary tables, trend graphs, latest data tables, and raw data tables.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="apm_01_0003__en-us_topic_0000001195725120_s8fe70ad540db459e961007661d2e6f9b"><h4 class="sectiontitle">Tracing</h4><p id="apm_01_0003__en-us_topic_0000001195725120_p735211153458">APM comprehensively monitors calls and displays service execution traces and statuses, helping you quickly locate performance bottlenecks and faults.</p>
|
||||
<ul id="apm_01_0003__en-us_topic_0000001195725120_ul8448181744511"><li id="apm_01_0003__en-us_topic_0000001195725120_li3826119144514">In the displayed trace list, click the target trace to view its basic information.</li><li id="apm_01_0003__en-us_topic_0000001195725120_li16448141704516">On the trace details page, you can view the trace's complete information, including the local method stack and remote call relationships.</li></ul>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
<p id="apm_01_0007__en-us_topic_0000001195725122_p18989153812142">With IAM, you can use your account to create IAM users for your employees, and assign permissions to the users to control their access to specific resources. For example, some software developers in your enterprise need to use APM resources but cannot delete them or perform any high-risk operations. To achieve this result, you can create IAM users for the software developers and grant them only the permissions required for using APM resources.</p>
|
||||
<p id="apm_01_0007__en-us_topic_0000001195725122_p19989203891418">If your account does not need individual IAM users for permissions management, you may skip over this chapter.</p>
|
||||
<p id="apm_01_0007__en-us_topic_0000001195725122_p09893386144">IAM can be used free of charge. You pay only for the resources in your account. For more information about IAM, see <a href="https://docs.otc.t-systems.com/identity-access-management/umn/service_overview/what_is_iam.html#iam-01-0026" target="_blank" rel="noopener noreferrer">IAM Service Overview</a>.</p>
|
||||
<div class="notice" id="apm_01_0007__en-us_topic_0000001195725122_note13241247165112"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="apm_01_0007__en-us_topic_0000001195725122_p8324144775119">Traces and Agent statistics do not involve your entity resources. To ensure statistics integrity, authorized users can check the trace and Agent statistics of the tenant, including those in other enterprise projects.</p>
|
||||
<div class="notice" id="apm_01_0007__en-us_topic_0000001195725122_note13241247165112"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="apm_01_0007__en-us_topic_0000001195725122_p8324144775119">Traces and Agent statistics do not involve your entity resources. To ensure statistics integrity, authorized users can check the trace and Agent statistics in all enterprise projects of a tenant.</p>
|
||||
</div></div>
|
||||
<div class="section" id="apm_01_0007__en-us_topic_0000001195725122_section186901838201416"><a name="apm_01_0007__en-us_topic_0000001195725122_section186901838201416"></a><a name="en-us_topic_0000001195725122_section186901838201416"></a><h4 class="sectiontitle">APM Permissions</h4><p id="apm_01_0007__en-us_topic_0000001195725122_p1198963851414">By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on APM.</p>
|
||||
<p id="apm_01_0007__en-us_topic_0000001195725122_p12920220637">APM is a global service. By default, the APM permissions granted to a user take effect in all regions supported by APM. APM resources are isolated by tenant. All users under a tenant share resources. To isolate resources, use enterprise projects.</p>
|
||||
@ -411,7 +411,7 @@
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.8.2.4.1.3 "><p id="apm_01_0007__en-us_topic_0000001195725122_p106076302115">x</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0007__en-us_topic_0000001195725122_row1325611011421"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.8.2.4.1.1 "><p id="apm_01_0007__en-us_topic_0000001195725122_p025620019429">Querying Agent statistics</p>
|
||||
<tr id="apm_01_0007__en-us_topic_0000001195725122_row1325611011421"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.8.2.4.1.1 "><p id="apm_01_0007__en-us_topic_0000001195725122_p025620019429">Checking Agent statistics</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.8.2.4.1.2 "><p id="apm_01_0007__en-us_topic_0000001195725122_p1298614516420">√</p>
|
||||
</td>
|
||||
|
||||
@ -1,7 +1,11 @@
|
||||
<a name="apm_01_0008"></a><a name="apm_01_0008"></a>
|
||||
|
||||
<h1 class="topictitle1">Privacy and Sensitive Information Protection Statement</h1>
|
||||
<div id="body8662426"><p id="apm_01_0008__en-us_topic_0000001240565041_p169792472518">All O&M data will be displayed on the APM console. Therefore, you are not advised to upload your privacy or sensitive data to APM. If you need to upload such data, encrypt them.</p>
|
||||
<div id="body8662426"><p id="apm_01_0008__en-us_topic_0000001240565041_p169792472518">All O&M data will be displayed on the APM console. Therefore, do not upload your privacy or sensitive data to APM. If you need to upload such data, encrypt them.</p>
|
||||
<div class="section" id="apm_01_0008__en-us_topic_0000001240565041_section88808557321"><h4 class="sectiontitle">How Do We Collect and Use Your Personal Information</h4><p id="apm_01_0008__en-us_topic_0000001240565041_p12581645269">We will only collect and use your personal information in accordance with the purposes and methods described in this Statement. If we want to use your personal information for purposes not stated herein, we will explicitly inform you about this by ourselves or through developers, and obtain your consent again or other legal bases. </p>
|
||||
</div>
|
||||
<div class="section" id="apm_01_0008__en-us_topic_0000001240565041_section2058617973412"><h4 class="sectiontitle">Managing Your Personal Information</h4><p id="apm_01_0008__en-us_topic_0000001240565041_p137932394276">We prioritize your concern for personal information. We will comply with applicable laws and regulations to ensure that you can exercise personal data subject rights, such as accessing, copying, modifying, and deleting personal information.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
|
||||
@ -69,7 +69,7 @@
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="apm_01_0044__en-us_topic_0000001490058100_row3294115263317"><td class="cellrowborder" rowspan="17" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p3294452123313">Database connection (<strong id="apm_01_0044__en-us_topic_0000001490058100_b1019011889">connection</strong>: APM counts SQL call statistics by database.)</p>
|
||||
<tbody><tr id="apm_01_0044__en-us_topic_0000001490058100_row3294115263317"><td class="cellrowborder" rowspan="17" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p3294452123313">Database connection (<strong id="apm_01_0044__en-us_topic_0000001490058100_b294930934">connection</strong>: APM counts SQL call statistics by database.)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.255723283015092%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0044__en-us_topic_0000001490058100_p22942525330">db</p>
|
||||
</td>
|
||||
@ -292,7 +292,7 @@
|
||||
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.8.1.6 "><p id="apm_01_0044__en-us_topic_0000001490058100_p53014522338">LAST</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0044__en-us_topic_0000001490058100_row123011252103318"><td class="cellrowborder" rowspan="6" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p330118527339">Exception (<strong id="apm_01_0044__en-us_topic_0000001490058100_b2111008800">exception</strong>: exception statistics about SQL calls)</p>
|
||||
<tr id="apm_01_0044__en-us_topic_0000001490058100_row123011252103318"><td class="cellrowborder" rowspan="6" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p330118527339">Exception (<strong id="apm_01_0044__en-us_topic_0000001490058100_b345002195">exception</strong>: exception statistics about SQL calls)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.255723283015092%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0044__en-us_topic_0000001490058100_p1830225210338">causeType</p>
|
||||
</td>
|
||||
@ -372,7 +372,7 @@
|
||||
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.8.1.6 "><p id="apm_01_0044__en-us_topic_0000001490058100_p13304165263318">LAST</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0044__en-us_topic_0000001490058100_row13304185213338"><td class="cellrowborder" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p133041152123312">Version (<strong id="apm_01_0044__en-us_topic_0000001490058100_b438043045">version</strong>: MySQL package version)</p>
|
||||
<tr id="apm_01_0044__en-us_topic_0000001490058100_row13304185213338"><td class="cellrowborder" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p133041152123312">Version (<strong id="apm_01_0044__en-us_topic_0000001490058100_b488843318">version</strong>: MySQL package version)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.255723283015092%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0044__en-us_topic_0000001490058100_p173051552113311">version</p>
|
||||
</td>
|
||||
@ -387,7 +387,7 @@
|
||||
<td class="cellrowborder" valign="top" width="17.66470058982305%" headers="mcps1.3.3.2.8.1.7 "><p id="apm_01_0044__en-us_topic_0000001490058100_p1730525210331">LAST</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0044__en-us_topic_0000001490058100_row230555263314"><td class="cellrowborder" rowspan="19" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p1130525293317">SQL monitoring (<strong id="apm_01_0044__en-us_topic_0000001490058100_b617092831">sql</strong>: APM counts call statistics by SQL.)</p>
|
||||
<tr id="apm_01_0044__en-us_topic_0000001490058100_row230555263314"><td class="cellrowborder" rowspan="19" valign="top" width="14.285714285714283%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0044__en-us_topic_0000001490058100_p1130525293317">SQL monitoring (<strong id="apm_01_0044__en-us_topic_0000001490058100_b157952737">sql</strong>: APM counts call statistics by SQL.)</p>
|
||||
<p id="apm_01_0044__en-us_topic_0000001490058100_p193051752143315"></p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="14.255723283015092%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0044__en-us_topic_0000001490058100_p130535216332">sql</p>
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="18.244526642007397%" headers="mcps1.3.2.2.8.1.6 "><p id="apm_01_0048__en-us_topic_0000001489578464_p1334174394310">-</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="22.45326402079376%" headers="mcps1.3.2.2.8.1.7 "><p id="apm_01_0048__en-us_topic_0000001489578464_p171593011431">URLs in the blacklist will not be collected. There are four modes: "startwith", "endwith", "include", and "regex".</p>
|
||||
<td class="cellrowborder" valign="top" width="22.45326402079376%" headers="mcps1.3.2.2.8.1.7 "><p id="apm_01_0048__en-us_topic_0000001489578464_p171593011431">URLs in the blocklist will not be collected. There are four modes: "startwith", "endwith", "include", and "regex".</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0048__en-us_topic_0000001489578464_row1642296123"><td class="cellrowborder" valign="top" width="11.526542037388783%" headers="mcps1.3.2.2.8.1.1 "><p id="apm_01_0048__en-us_topic_0000001489578464_p915163020436">Max. Status Code Length</p>
|
||||
|
||||
@ -219,7 +219,7 @@
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="apm_01_0052__en-us_topic_0000001540658301_row1715151411395"><td class="cellrowborder" rowspan="5" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p31515145395">Summary (<strong id="apm_01_0052__en-us_topic_0000001540658301_b740634665">total</strong>: URL call statistics summary)</p>
|
||||
<tbody><tr id="apm_01_0052__en-us_topic_0000001540658301_row1715151411395"><td class="cellrowborder" rowspan="5" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p31515145395">Summary (<strong id="apm_01_0052__en-us_topic_0000001540658301_b489220262">total</strong>: URL call statistics summary)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.07241448289658%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0052__en-us_topic_0000001540658301_p101531415391">errorCount</p>
|
||||
</td>
|
||||
@ -286,7 +286,7 @@
|
||||
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.8.1.6 "><p id="apm_01_0052__en-us_topic_0000001540658301_p120914113920">SUM</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0052__en-us_topic_0000001540658301_row102011423918"><td class="cellrowborder" rowspan="3" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p8207142396">Status code (<strong id="apm_01_0052__en-us_topic_0000001540658301_b558271690">statuscode</strong>: APM counts URL call statistics based on the status code returned.)</p>
|
||||
<tr id="apm_01_0052__en-us_topic_0000001540658301_row102011423918"><td class="cellrowborder" rowspan="3" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p8207142396">Status code (<strong id="apm_01_0052__en-us_topic_0000001540658301_b232531875">statuscode</strong>: APM counts URL call statistics based on the status code returned.)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.07241448289658%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0052__en-us_topic_0000001540658301_p92012141397">code</p>
|
||||
</td>
|
||||
@ -327,7 +327,7 @@
|
||||
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.8.1.6 "><p id="apm_01_0052__en-us_topic_0000001540658301_p10213140395">LAST</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0052__en-us_topic_0000001540658301_row11212146398"><td class="cellrowborder" rowspan="19" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p1421514153911">URL monitoring (<strong id="apm_01_0052__en-us_topic_0000001540658301_b776149852">url</strong>: APM counts URL call statistics by URL.)</p>
|
||||
<tr id="apm_01_0052__en-us_topic_0000001540658301_row11212146398"><td class="cellrowborder" rowspan="19" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p1421514153911">URL monitoring (<strong id="apm_01_0052__en-us_topic_0000001540658301_b883834437">url</strong>: APM counts URL call statistics by URL.)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.07241448289658%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0052__en-us_topic_0000001540658301_p192151410391">url</p>
|
||||
</td>
|
||||
@ -576,7 +576,7 @@
|
||||
<td class="cellrowborder" valign="top" headers="mcps1.3.3.2.8.1.6 "><p id="apm_01_0052__en-us_topic_0000001540658301_p83111403911">SUM</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0052__en-us_topic_0000001540658301_row20315145393"><td class="cellrowborder" rowspan="9" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p631314143911">Cluster call (<strong id="apm_01_0052__en-us_topic_0000001540658301_b251088118">user</strong>: APM counts URL call statistics based on the cluster ID of the caller.)</p>
|
||||
<tr id="apm_01_0052__en-us_topic_0000001540658301_row20315145393"><td class="cellrowborder" rowspan="9" valign="top" width="15.413082616523303%" headers="mcps1.3.3.2.8.1.1 "><p id="apm_01_0052__en-us_topic_0000001540658301_p631314143911">Cluster call (<strong id="apm_01_0052__en-us_topic_0000001540658301_b1460318697">user</strong>: APM counts URL call statistics based on the cluster ID of the caller.)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="12.07241448289658%" headers="mcps1.3.3.2.8.1.2 "><p id="apm_01_0052__en-us_topic_0000001540658301_p1326147391">clusterId</p>
|
||||
</td>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="apm_01_0063__en-us_topic_0000001489578472_row8514133591113"><td class="cellrowborder" rowspan="5" valign="top" width="15.413082616523305%" headers="mcps1.3.2.2.8.1.1 "><p id="apm_01_0063__en-us_topic_0000001489578472_p17514635101119">Exception (<strong id="apm_01_0063__en-us_topic_0000001489578472_b1526782406">exception</strong>: exception statistics of RabbitMqCommon calls)</p>
|
||||
<tbody><tr id="apm_01_0063__en-us_topic_0000001489578472_row8514133591113"><td class="cellrowborder" rowspan="5" valign="top" width="15.413082616523305%" headers="mcps1.3.2.2.8.1.1 "><p id="apm_01_0063__en-us_topic_0000001489578472_p17514635101119">Exception (<strong id="apm_01_0063__en-us_topic_0000001489578472_b109906742">exception</strong>: exception statistics of RabbitMqCommon calls)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="15.413082616523305%" headers="mcps1.3.2.2.8.1.2 "><p id="apm_01_0063__en-us_topic_0000001489578472_p1151419357113">exceptionType</p>
|
||||
</td>
|
||||
@ -246,7 +246,7 @@
|
||||
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.8.1.6 "><p id="apm_01_0063__en-us_topic_0000001489578472_p752211355110">SUM</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0063__en-us_topic_0000001489578472_row11522935171110"><td class="cellrowborder" valign="top" width="15.413082616523305%" headers="mcps1.3.2.2.8.1.1 "><p id="apm_01_0063__en-us_topic_0000001489578472_p152213510119">RabbitMQ version (<strong id="apm_01_0063__en-us_topic_0000001489578472_b304065457">version</strong>)</p>
|
||||
<tr id="apm_01_0063__en-us_topic_0000001489578472_row11522935171110"><td class="cellrowborder" valign="top" width="15.413082616523305%" headers="mcps1.3.2.2.8.1.1 "><p id="apm_01_0063__en-us_topic_0000001489578472_p152213510119">RabbitMQ version (<strong id="apm_01_0063__en-us_topic_0000001489578472_b1011823489">version</strong>)</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="15.413082616523305%" headers="mcps1.3.2.2.8.1.2 "><p id="apm_01_0063__en-us_topic_0000001489578472_p35221035131117">version</p>
|
||||
</td>
|
||||
|
||||
@ -1,38 +1,45 @@
|
||||
<a name="apm_01_0093"></a><a name="apm_01_0093"></a>
|
||||
|
||||
<h1 class="topictitle1">JavaAgent Updates</h1>
|
||||
<div id="body8662426">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apm_01_0093__en-us_topic_0000001622239212_table2083011664513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>JavaAgent updates</caption><thead align="left"><tr id="apm_01_0093__en-us_topic_0000001622239212_row1883017169452"><th align="left" class="cellrowborder" valign="top" width="21.68%" id="mcps1.3.1.2.3.1.1"><p id="apm_01_0093__en-us_topic_0000001622239212_p10830716194511">Version</p>
|
||||
<div id="body8662426"><div class="section" id="apm_01_0093__en-us_topic_0000001622239212_section516578205117"><h4 class="sectiontitle">Constraints</h4><ul id="apm_01_0093__en-us_topic_0000001622239212_ul15918412165913"><li id="apm_01_0093__en-us_topic_0000001622239212_li192814459256">To download Agents, see <a href="apm_02_0007.html">JavaAgent Download Addresses</a>.</li></ul>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apm_01_0093__en-us_topic_0000001622239212_table11362184317223" frame="border" border="1" rules="all"><caption><b>Table 1 </b>JavaAgent updates</caption><thead align="left"><tr id="apm_01_0093__en-us_topic_0000001622239212_row23631643172215"><th align="left" class="cellrowborder" valign="top" width="21.41%" id="mcps1.3.2.2.3.1.1"><p id="apm_01_0093__en-us_topic_0000001622239212_p11523203118235">Version</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="78.32000000000001%" id="mcps1.3.1.2.3.1.2"><p id="apm_01_0093__en-us_topic_0000001622239212_p483161616459">Description</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="78.59%" id="mcps1.3.2.2.3.1.2"><p id="apm_01_0093__en-us_topic_0000001622239212_p7523123115239">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="apm_01_0093__en-us_topic_0000001622239212_row182321234144717"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.1.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p19233173417478">2.4.8-jdk17</p>
|
||||
<tbody><tr id="apm_01_0093__en-us_topic_0000001622239212_row63631433228"><td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.2.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p19233173417478">2.4.8-jdk17</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="78.32000000000001%" headers="mcps1.3.1.2.3.1.2 "><p id="apm_01_0093__en-us_topic_0000001622239212_p4108105783918">1. Supported Redisson 3.17.x.</p>
|
||||
<p id="apm_01_0093__en-us_topic_0000001622239212_p110845715390">2. Supported top percentile (TP) on the URL page.</p>
|
||||
<td class="cellrowborder" valign="top" width="78.59%" headers="mcps1.3.2.2.3.1.2 "><ol id="apm_01_0093__en-us_topic_0000001622239212_ol421917106264"><li id="apm_01_0093__en-us_topic_0000001622239212_li17219210172610">Supported Redisson 3.17.x.</li><li id="apm_01_0093__en-us_topic_0000001622239212_li15219410142616">Supported TP on the URL page.</li></ol>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0093__en-us_topic_0000001622239212_row15243143512522"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.1.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p182430356529">2.3.15</p>
|
||||
<tr id="apm_01_0093__en-us_topic_0000001622239212_row12363164315225"><td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.2.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p53001928123212">2.4.8</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="78.32000000000001%" headers="mcps1.3.1.2.3.1.2 "><p id="apm_01_0093__en-us_topic_0000001622239212_p743219417530">1. Added support for Dubbo 2.8.x.</p>
|
||||
<p id="apm_01_0093__en-us_topic_0000001622239212_p44331241155313">2. Supported JDK HTTP subclasses.</p>
|
||||
<td class="cellrowborder" valign="top" width="78.59%" headers="mcps1.3.2.2.3.1.2 "><ol id="apm_01_0093__en-us_topic_0000001622239212_ol19219121012261"><li id="apm_01_0093__en-us_topic_0000001622239212_li172191310132612">Supported Redisson 3.17.x.</li><li id="apm_01_0093__en-us_topic_0000001622239212_li121941052620">Supported top percentile (TP) on the URL page.<div class="note" id="apm_01_0093__en-us_topic_0000001622239212_note5566027103916"><span class="notetitle"> NOTE: </span><div class="notebody"><ol type="a" id="apm_01_0093__en-us_topic_0000001622239212_ol152201910182620"><li id="apm_01_0093__en-us_topic_0000001622239212_li3220181092615">The 2.4.8 version only supports JDK 8.</li></ol>
|
||||
</div></div>
|
||||
</li></ol>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="apm_01_0093__en-us_topic_0000001622239212_row143631643142215"><td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.2.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p17280151111375">2.3.15</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="78.59%" headers="mcps1.3.2.2.3.1.2 "><ol id="apm_01_0093__en-us_topic_0000001622239212_ol1922031072617"><li id="apm_01_0093__en-us_topic_0000001622239212_li3220610192614">Supported Dubbo 2.8.x.</li><li id="apm_01_0093__en-us_topic_0000001622239212_li12220171022620">Supported JDK HTTP subclasses.</li></ol>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apm_01_0093__en-us_topic_0000001622239212_table1415773664713" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Latest JavaAgent versions on CCE</caption><thead align="left"><tr id="apm_01_0093__en-us_topic_0000001622239212_row18157736164713"><th align="left" class="cellrowborder" valign="top" width="21.490000000000002%" id="mcps1.3.2.2.3.1.1"><p id="apm_01_0093__en-us_topic_0000001622239212_p1922214664711">Version</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="apm_01_0093__en-us_topic_0000001622239212_table1415773664713" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Latest JavaAgent versions on CCE</caption><thead align="left"><tr id="apm_01_0093__en-us_topic_0000001622239212_row18157736164713"><th align="left" class="cellrowborder" valign="top" width="21.490000000000002%" id="mcps1.3.3.2.3.1.1"><p id="apm_01_0093__en-us_topic_0000001622239212_p1922214664711">Version</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="78.51%" id="mcps1.3.2.2.3.1.2"><p id="apm_01_0093__en-us_topic_0000001622239212_p15223446184719">Actual Version</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="78.51%" id="mcps1.3.3.2.3.1.2"><p id="apm_01_0093__en-us_topic_0000001622239212_p15223446184719">Actual Version</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="apm_01_0093__en-us_topic_0000001622239212_row6158183612471"><td class="cellrowborder" valign="top" width="21.490000000000002%" headers="mcps1.3.2.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p1223114611476">latest</p>
|
||||
<tbody><tr id="apm_01_0093__en-us_topic_0000001622239212_row6158183612471"><td class="cellrowborder" valign="top" width="21.490000000000002%" headers="mcps1.3.3.2.3.1.1 "><p id="apm_01_0093__en-us_topic_0000001622239212_p1223114611476">latest</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="78.51%" headers="mcps1.3.2.2.3.1.2 "><p id="apm_01_0093__en-us_topic_0000001622239212_p3538829205315">2.4.8-jdk17; compatible with x86 and Arm architectures</p>
|
||||
<td class="cellrowborder" valign="top" width="78.51%" headers="mcps1.3.3.2.3.1.2 "><ol id="apm_01_0093__en-us_topic_0000001622239212_ol146681136162617"><li id="apm_01_0093__en-us_topic_0000001622239212_li266893620262">2.4.8-jdk17; compatible with x86 and Arm architectures</li></ol>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="apm_03_0002.html">What Is APM's Metric Data Sampling Policy?</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="apm_03_0004.html">Why Does Metric Data Collection Fail?</a></strong><br>
|
||||
<li class="ulchildlink"><strong><a href="apm_03_0004.html">Why Does APM Metric Collection Fail?</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="apm_03_0001.html">Are APM Agents Compatible with Other Agents Such as Pinpoint?</a></strong><br>
|
||||
</li>
|
||||
|
||||
@ -1,9 +1,8 @@
|
||||
<a name="apm_02_0001"></a><a name="apm_02_0001"></a>
|
||||
|
||||
<h1 class="topictitle1">Enabling APM</h1>
|
||||
<div id="body8662426"><ol id="apm_02_0001__en-us_topic_0000001196115564_ol38771617453"><li id="apm_02_0001__en-us_topic_0000001196115564_li319864615619">Enable APM.<ol type="a" id="apm_02_0001__en-us_topic_0000001196115564_ol14549544105011"><li id="apm_02_0001__en-us_topic_0000001196115564_li25506441507">Log in to the APM console.<div class="note" id="apm_02_0001__en-us_topic_0000001196115564_note6819141095118"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="apm_02_0001__en-us_topic_0000001196115564_p108191010115111">If you log in to the APM console for the first time, you can choose the free or enterprise edition. For details, see <a href="apm_01_0006.html#apm_01_0006">Edition Differences</a>.</p>
|
||||
</div></div>
|
||||
</li><li id="apm_02_0001__en-us_topic_0000001196115564_li17918286589">Click <span><img id="apm_02_0001__en-us_topic_0000001196115564_image49532511105" src="en-us_image_0000001240715511.png"></span> on the left and choose <strong id="apm_02_0001__en-us_topic_0000001196115564_b939912113565">Application</strong> > <strong id="apm_02_0001__en-us_topic_0000001196115564_b109542541013">Application Performance Management</strong>.</li></ol>
|
||||
<div id="body8662426"><ol id="apm_02_0001__en-us_topic_0000001196115564_ol38771617453"><li id="apm_02_0001__en-us_topic_0000001196115564_li319864615619">Enable APM.<ol type="a" id="apm_02_0001__en-us_topic_0000001196115564_ol14549544105011"><li id="apm_02_0001__en-us_topic_0000001196115564_li25506441507">Log in to the APM console.<p id="apm_02_0001__en-us_topic_0000001196115564_p848845112819"><a name="apm_02_0001__en-us_topic_0000001196115564_li25506441507"></a><a name="en-us_topic_0000001196115564_li25506441507"></a>If you log in to the APM console for the first time, you can choose the free or enterprise edition. For more information, see <a href="apm_01_0006.html">Edition Differences</a>.</p>
|
||||
</li><li id="apm_02_0001__en-us_topic_0000001196115564_li17918286589">Click <span><img id="apm_02_0001__en-us_topic_0000001196115564_image592275674514" src="en-us_image_0000001240715511.png"></span> on the left and choose <strong id="apm_02_0001__en-us_topic_0000001196115564_b1560919358410">Application</strong> > <strong id="apm_02_0001__en-us_topic_0000001196115564_b147025784119">Application Performance Management</strong>.</li></ol>
|
||||
</li></ol><ol start="2" id="apm_02_0001__en-us_topic_0000001196115564_ol1299951218417"><li id="apm_02_0001__en-us_topic_0000001196115564_li8999312749">Obtain the access key that is automatically created.<p id="apm_02_0001__en-us_topic_0000001196115564_p399812121410"><a name="apm_02_0001__en-us_topic_0000001196115564_li8999312749"></a><a name="en-us_topic_0000001196115564_li8999312749"></a>APM uses AK/SK for signature verification. Only authorized accounts can report data.</p>
|
||||
<ol type="a" id="apm_02_0001__en-us_topic_0000001196115564_ol699917120413"><li id="apm_02_0001__en-us_topic_0000001196115564_li699813128418">Log in to the APM console.</li><li id="apm_02_0001__en-us_topic_0000001196115564_li14998121216410">In the navigation pane, choose <strong id="apm_02_0001__en-us_topic_0000001196115564_b173342493515">System Management</strong> > <strong id="apm_02_0001__en-us_topic_0000001196115564_b15335174919514">Access Keys</strong>.</li><li id="apm_02_0001__en-us_topic_0000001196115564_li15999121216416">On the <strong id="apm_02_0001__en-us_topic_0000001196115564_b350054519716">Access Keys</strong> page, view the access key that has been automatically created.</li></ol>
|
||||
</li></ol>
|
||||
|
||||
@ -7,21 +7,21 @@
|
||||
<ul id="apm_02_0004__en-us_topic_0000001241035473_ul1179813091714"><li id="apm_02_0004__en-us_topic_0000001241035473_li1075748191717">The AK/SK required for accessing JavaAgents have been obtained. To obtain them, log in to the APM console and choose <strong id="apm_02_0004__en-us_topic_0000001241035473_b774617587357">System Management</strong> > <strong id="apm_02_0004__en-us_topic_0000001241035473_b1174625819355">Access Keys</strong> in the navigation pane.<div class="fignone" id="apm_02_0004__en-us_topic_0000001241035473_fig54120529159"><span class="figcap"><b>Figure 1 </b>Obtaining an AK/SK</span><br><span><img id="apm_02_0004__en-us_topic_0000001241035473_image541652181519" src="en-us_image_0000001627629722.png" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="apm_02_0004__en-us_topic_0000001241035473_section2010313462448"><h4 class="sectiontitle">Procedure</h4><ol id="apm_02_0004__en-us_topic_0000001241035473_ol1351071614214"><li id="apm_02_0004__en-us_topic_0000001241035473_li151071613218"><span>Download <strong id="apm_02_0004__en-us_topic_0000001241035473_b1914567397">apm-javaagent</strong> to any directory of your host. For the download address, see <a href="apm_02_0007.html#apm_02_0007">JavaAgent Download Addresses</a>.</span><p><p id="apm_02_0004__en-us_topic_0000001241035473_p204291036131319">Example command:</p>
|
||||
<div class="section" id="apm_02_0004__en-us_topic_0000001241035473_section2010313462448"><h4 class="sectiontitle">Procedure</h4><ol id="apm_02_0004__en-us_topic_0000001241035473_ol1351071614214"><li id="apm_02_0004__en-us_topic_0000001241035473_li103897468117"><span>Use a remote login tool, such as PuTTY, to log in to the Linux host where the Agent is to be installed and run related commands as the <strong id="apm_02_0004__en-us_topic_0000001241035473_b180817313589">root</strong> user.</span></li><li id="apm_02_0004__en-us_topic_0000001241035473_li151071613218"><span>Download JavaAgent to any directory on the host to be connected to APM. For details, see <a href="apm_02_0007.html#apm_02_0007__en-us_topic_0000001222407900_table145112051071">JavaAgent Download Addresses</a>.</span><p><p id="apm_02_0004__en-us_topic_0000001241035473_p204291036131319">Example command:</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p1982220399136"><strong id="apm_02_0004__en-us_topic_0000001241035473_b136629271345">curl -O https://xxx/apm-javaagent-x.x.x.tar</strong></p>
|
||||
</p></li></ol><ol start="2" id="apm_02_0004__en-us_topic_0000001241035473_ol149258107224"><li id="apm_02_0004__en-us_topic_0000001241035473_li10925151019228"><span>Run the <strong id="apm_02_0004__en-us_topic_0000001241035473_b791275415136">tar</strong> command to decompress the JavaAgent package.</span><p><p id="apm_02_0004__en-us_topic_0000001241035473_p16400415101716">Example command:</p>
|
||||
</p></li></ol><ol start="3" id="apm_02_0004__en-us_topic_0000001241035473_ol149258107224"><li id="apm_02_0004__en-us_topic_0000001241035473_li10925151019228"><span>Run the <strong id="apm_02_0004__en-us_topic_0000001241035473_b791275415136">tar</strong> command to decompress the JavaAgent package.</span><p><p id="apm_02_0004__en-us_topic_0000001241035473_p16400415101716">Example command:</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p1370151611713"><strong id="apm_02_0004__en-us_topic_0000001241035473_b3689191293419">tar -xvf apm-javaagent-x.x.x.tar</strong></p>
|
||||
</p></li></ol><ol start="3" id="apm_02_0004__en-us_topic_0000001241035473_ol9590183312221"><li id="apm_02_0004__en-us_topic_0000001241035473_li15590633102216"><span>Modify the <strong id="apm_02_0004__en-us_topic_0000001241035473_b42371537063">apm.config</strong> file in the JavaAgent package. Configure <strong id="apm_02_0004__en-us_topic_0000001241035473_b1965341911718">master.address</strong> by referring to <a href="apm_02_0008.html#apm_02_0008">Access Addresses</a>, and add the AK/SK to the configuration file, as shown in the following figure.</span><p><div class="fignone" id="apm_02_0004__en-us_topic_0000001241035473_fig27531238155512"><span class="figcap"><b>Figure 2 </b>Adding the AK/SK</span><br><span><img id="apm_02_0004__en-us_topic_0000001241035473_image125131984515" src="en-us_image_0000001196275562.png" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</p></li></ol><ol start="4" id="apm_02_0004__en-us_topic_0000001241035473_ol1426015562210"><li id="apm_02_0004__en-us_topic_0000001241035473_li192616558224"><span>Modify the startup script of the Java process.</span><p><p id="apm_02_0004__en-us_topic_0000001241035473_p1251844613152">Add the path of the <strong id="apm_02_0004__en-us_topic_0000001241035473_b3684171163912">apm-javaagent.jar</strong> package and the component name of the Java process to the end of the Java command in the service startup script.</p>
|
||||
</p></li></ol><ol start="4" id="apm_02_0004__en-us_topic_0000001241035473_ol9590183312221"><li id="apm_02_0004__en-us_topic_0000001241035473_li15590633102216"><span>Modify the <strong id="apm_02_0004__en-us_topic_0000001241035473_b42371537063">apm.config</strong> file in the JavaAgent package. For details about how to configure <strong id="apm_02_0004__en-us_topic_0000001241035473_b216541313410">master.address</strong>, see <a href="apm_02_0008.html#apm_02_0008__en-us_topic_0000001266768045_table201446686">Access Addresses</a>. Enter the AK/SK to the configuration file, as shown in the following figure.</span><p><div class="fignone" id="apm_02_0004__en-us_topic_0000001241035473_fig27531238155512"><span class="figcap"><b>Figure 2 </b>Adding the AK/SK</span><br><span><img id="apm_02_0004__en-us_topic_0000001241035473_image125131984515" src="en-us_image_0000001196275562.png" title="Click to enlarge" class="imgResize"></span></div>
|
||||
</p></li></ol><ol start="5" id="apm_02_0004__en-us_topic_0000001241035473_ol1426015562210"><li id="apm_02_0004__en-us_topic_0000001241035473_li192616558224"><span>Modify the startup script of the Java process.</span><p><p id="apm_02_0004__en-us_topic_0000001241035473_p1251844613152">Add the path of the <strong id="apm_02_0004__en-us_topic_0000001241035473_b3684171163912">apm-javaagent.jar</strong> package and the component name of the Java process to the end of the Java command in the service startup script.</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p1431613368238">Example of adding <strong id="apm_02_0004__en-us_topic_0000001241035473_b26585317442">-javaagent</strong> parameters:</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p010062517563">java <strong id="apm_02_0004__en-us_topic_0000001241035473_b2100125165610">-javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName={appName}</strong></p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p5955112895320">If your enterprise has a large number of services, you can add more complex configurations. For example:</p>
|
||||
<div class="p" id="apm_02_0004__en-us_topic_0000001241035473_p1552553615144">java <strong id="apm_02_0004__en-us_topic_0000001241035473_b26335316201">-javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName=myApp</strong><strong id="apm_02_0004__en-us_topic_0000001241035473_b14301750202416">,env=myEnv,envTag=myTag,business=myBusiness,subBusiness=mySub</strong><div class="note" id="apm_02_0004__en-us_topic_0000001241035473_note777185944917"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="apm_02_0004__en-us_topic_0000001241035473_ul2140043162019"><li id="apm_02_0004__en-us_topic_0000001241035473_li12341425163812">The preceding parameters are built-in CMDB information of APM. For details, see <a href="apm_07_0050.html">CMDB Management</a>.</li><li id="apm_02_0004__en-us_topic_0000001241035473_li1626720479201">Due to historical reasons, the metadata of APM startup parameters conflicts with some CMDB concepts. The following shows the details.<p id="apm_02_0004__en-us_topic_0000001241035473_p9986143115618"><a name="apm_02_0004__en-us_topic_0000001241035473_li1626720479201"></a><a name="en-us_topic_0000001241035473_li1626720479201"></a>Generally, the startup parameter is set to <strong id="apm_02_0004__en-us_topic_0000001241035473_b1105152412214">-javaagent:D:\javaagent-package\apm-javaagent\apm-javaagent.jar=appName=xxx,env=yyy,business=zzz,subBusiness=sss,envTag=xxx</strong>. <strong id="apm_02_0004__en-us_topic_0000001241035473_b021773391220">appName</strong> indicates a component, <strong id="apm_02_0004__en-us_topic_0000001241035473_b123144061212">business</strong> indicates an application, <strong id="apm_02_0004__en-us_topic_0000001241035473_b87311245101216">subBusiness</strong> indicates a sub-application, and <strong id="apm_02_0004__en-us_topic_0000001241035473_b10763165261217">envTag</strong> indicates an environment tag.</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p1552553615144">java <strong id="apm_02_0004__en-us_topic_0000001241035473_b26335316201">-javaagent:/xxx/apm-javaagent/apm-javaagent.jar=appName=myApp</strong><strong id="apm_02_0004__en-us_topic_0000001241035473_b14301750202416">,env=myEnv,envTag=myTag,business=myBusiness,subBusiness=mySub</strong></p>
|
||||
<ul id="apm_02_0004__en-us_topic_0000001241035473_ul2140043162019"><li id="apm_02_0004__en-us_topic_0000001241035473_li12341425163812">The preceding parameters are built-in CMDB information of APM. For details, see <a href="apm_07_0050.html">CMDB Management</a>.</li><li id="apm_02_0004__en-us_topic_0000001241035473_li1626720479201">Due to historical reasons, the metadata of APM startup parameters conflicts with some CMDB concepts. The following shows the details.<p id="apm_02_0004__en-us_topic_0000001241035473_p9986143115618"><a name="apm_02_0004__en-us_topic_0000001241035473_li1626720479201"></a><a name="en-us_topic_0000001241035473_li1626720479201"></a>Generally, the startup parameter is set to <strong id="apm_02_0004__en-us_topic_0000001241035473_b1105152412214">-javaagent:D:\javaagent-package\apm-javaagent\apm-javaagent.jar=appName=xxx,env=yyy,business=zzz,subBusiness=sss,envTag=xxx</strong>. <strong id="apm_02_0004__en-us_topic_0000001241035473_b021773391220">appName</strong> indicates a component, <strong id="apm_02_0004__en-us_topic_0000001241035473_b123144061212">business</strong> indicates an application, <strong id="apm_02_0004__en-us_topic_0000001241035473_b87311245101216">subBusiness</strong> indicates a sub-application, and <strong id="apm_02_0004__en-us_topic_0000001241035473_b10763165261217">envTag</strong> indicates an environment tag.</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p103019071315">If <strong id="apm_02_0004__en-us_topic_0000001241035473_b10691622201312">business</strong> is not set on the web page, the system reports an error when the JavaAgent is started. If other parameters (<strong id="apm_02_0004__en-us_topic_0000001241035473_b594982611410">subBusiness</strong>, <strong id="apm_02_0004__en-us_topic_0000001241035473_b9870124391417">appName</strong>, <strong id="apm_02_0004__en-us_topic_0000001241035473_b4955603152">env</strong>, and <strong id="apm_02_0004__en-us_topic_0000001241035473_b12589154731419">envTag</strong>) are not set, the system automatically creates them when the JavaAgent is started.</p>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p2446800313">Component names are unique under an application.</p>
|
||||
</li></ul>
|
||||
</div></div>
|
||||
</div>
|
||||
<p id="apm_02_0004__en-us_topic_0000001241035473_p157904414305"></p>
|
||||
</p></li><li id="apm_02_0004__en-us_topic_0000001241035473_li8360181332311"><span>Redeploy the application.</span></li></ol>
|
||||
</div>
|
||||
</div>
|
||||
|
||||