Compare commits
30 Commits
fix_python
...
cce_umn_20
| Author | SHA1 | Date | |
|---|---|---|---|
| af58d555be | |||
| 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,
|
||||
|
||||
@ -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
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
221
docs/asm/api-ref/ALL_META.TXT.json
Normal file
110
docs/asm/api-ref/CLASS.TXT.json
Normal file
3
docs/asm/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
||||
version=""
|
||||
language="en-us"
|
||||
type=""
|
||||
11
docs/asm/api-ref/asm_api_0012.html
Normal file
@ -0,0 +1,11 @@
|
||||
<a name="asm_api_0012"></a><a name="asm_api_0012"></a>
|
||||
|
||||
<h1 class="topictitle1">API</h1>
|
||||
<div id="body1467184597184"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0100.html">Service Mesh APIs</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
15
docs/asm/api-ref/asm_api_0016.html
Normal file
@ -0,0 +1,15 @@
|
||||
<a name="asm_api_0016"></a><a name="asm_api_0016"></a>
|
||||
|
||||
<h1 class="topictitle1">Appendix</h1>
|
||||
<div id="body1555402084056"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0017.html">Status Codes</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0018.html">Error Codes</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0019.html">Obtaining a Project ID</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
322
docs/asm/api-ref/asm_api_0017.html
Normal file
112
docs/asm/api-ref/asm_api_0018.html
Normal file
41
docs/asm/api-ref/asm_api_0019.html
Normal file
@ -0,0 +1,41 @@
|
||||
<a name="asm_api_0019"></a><a name="asm_api_0019"></a>
|
||||
|
||||
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
||||
<div id="body1555402084056"><div class="section" id="asm_api_0019__section414113577116"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="asm_api_0019__p316610218817">A project ID can be obtained by calling a specific API. For details, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845625.html" target="_blank" rel="noopener noreferrer">Querying Project Information Based on the Specified Criteria</a>.</p>
|
||||
<p id="asm_api_0019__p177571552165618">The API used to obtain a project ID is <strong id="asm_api_0019__b178585383442423">GET https://</strong><em id="asm_api_0019__i190037548642423">{Endpoint}</em><strong id="asm_api_0019__b49196448442423">/v3/projects/</strong>, where <em id="asm_api_0019__i95883835342423">{Endpoint}</em> indicates the IAM endpoint. You can obtain the IAM endpoint from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
||||
<p id="asm_api_0019__p1461198134114">In the following example, <strong id="asm_api_0019__b893961492019">id</strong> indicates the project ID.</p>
|
||||
<pre class="screen" id="asm_api_0019__screen676419149446">{
|
||||
"projects": [
|
||||
{
|
||||
"domain_id": "65382450e8f64ac0870cd180d14e684b",
|
||||
"is_domain": false,
|
||||
"parent_id": "65382450e8f64ac0870cd180d14e684b",
|
||||
"name": "eu-de",
|
||||
"description": "",
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
|
||||
},
|
||||
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects"
|
||||
}
|
||||
}</pre>
|
||||
</div>
|
||||
<div class="section" id="asm_api_0019__section15182163514118"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="asm_api_0019__p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
|
||||
<ol id="asm_api_0019__ol8715914194127"><li id="asm_api_0019__li50056756194127">Log in to the management console.</li><li id="asm_api_0019__li4130312894059">Click the username and select <strong id="asm_api_0019__b3717155511209">My Credentials</strong> from the drop-down list. On the <strong id="asm_api_0019__b127416372014">API Credentials</strong> page, view the project ID in the project list.</li></ol>
|
||||
<p id="asm_api_0019__p204091619102318">If a project contains multiple sub-projects, click the plus (+) sign to view sub-project IDs.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="asm_api_0016.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
31
docs/asm/api-ref/asm_api_0021.html
Normal file
@ -0,0 +1,31 @@
|
||||
<a name="asm_api_0021"></a><a name="asm_api_0021"></a>
|
||||
|
||||
<h1 class="topictitle1">Change History</h1>
|
||||
<div id="body1555402084056">
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0021__table433719541985" frame="border" border="1" rules="all"><thead align="left"><tr id="asm_api_0021__row173385541889"><th align="left" class="cellrowborder" valign="top" width="24.310000000000002%" id="mcps1.3.1.1.3.1.1"><p id="asm_api_0021__p0338105417812">Release On</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="75.69%" id="mcps1.3.1.1.3.1.2"><p id="asm_api_0021__p533895418810">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="asm_api_0021__row158031552498"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p4804952394">2025-03-07</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="75.69%" headers="mcps1.3.1.1.3.1.2 "><p id="asm_api_0021__p16804252798">Deleted duplicate links in <a href="asm_api_0012.html">API</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="asm_api_0021__row6787101995017"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p14770152316507">2024-12-11</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="75.69%" headers="mcps1.3.1.1.3.1.2 "><p id="asm_api_0021__p18770182319503">Based on review comments, this document is optimized as follows:</p>
|
||||
<ul id="asm_api_0021__ul5493123335311"><li id="asm_api_0021__li1549313335315">Modified the API parameters.</li><li id="asm_api_0021__li39911035165316">Added response examples.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="asm_api_0021__row53381754089"><td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="asm_api_0021__p113381954983">2024-10-25</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="75.69%" headers="mcps1.3.1.1.3.1.2 "><p id="asm_api_0021__p32181214812">First release.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
8
docs/asm/api-ref/asm_api_0027.html
Normal file
@ -0,0 +1,8 @@
|
||||
<a name="asm_api_0027"></a><a name="asm_api_0027"></a>
|
||||
|
||||
<h1 class="topictitle1">API Usage Guidelines</h1>
|
||||
<div id="body0000001910516785"><p id="asm_api_0027__p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Uniform Resource Locator (URL). A URL is usually in the following format: <em id="asm_api_0027__i1791616172415">https://Endpoint/URI</em>. In the URL, <strong id="asm_api_0027__b14125626142410">uri</strong> indicates the resource path, that is, the API access path.</p>
|
||||
<p id="asm_api_0027__p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="asm_api_0027__b08771566245">application/json</strong>.</p>
|
||||
<p id="asm_api_0027__p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
|
||||
</div>
|
||||
|
||||
21
docs/asm/api-ref/asm_api_0100.html
Normal file
@ -0,0 +1,21 @@
|
||||
<a name="asm_api_0100"></a><a name="asm_api_0100"></a>
|
||||
|
||||
<h1 class="topictitle1">Service Mesh APIs</h1>
|
||||
<div id="body212mcpsimp"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0101.html">Creating a Service Mesh</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0102.html">Deleting a Service Mesh</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0103.html">Querying a Service Mesh</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="asm_api_0104.html">Querying the Service Mesh List</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="asm_api_0012.html">API</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
876
docs/asm/api-ref/asm_api_0101.html
Normal file
424
docs/asm/api-ref/asm_api_0102.html
Normal file
424
docs/asm/api-ref/asm_api_0103.html
Normal file
430
docs/asm/api-ref/asm_api_0104.html
Normal file
BIN
docs/asm/api-ref/public_sys-resources/caution_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/asm/api-ref/public_sys-resources/danger_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/asm/api-ref/public_sys-resources/delta.gif
Normal file
|
After Width: | Height: | Size: 836 B |
BIN
docs/asm/api-ref/public_sys-resources/deltaend.gif
Normal file
|
After Width: | Height: | Size: 834 B |
BIN
docs/asm/api-ref/public_sys-resources/icon-arrowdn.gif
Normal file
|
After Width: | Height: | Size: 1.8 KiB |
BIN
docs/asm/api-ref/public_sys-resources/icon-arrowrt.gif
Normal file
|
After Width: | Height: | Size: 1.8 KiB |
BIN
docs/asm/api-ref/public_sys-resources/icon-caution.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/asm/api-ref/public_sys-resources/icon-danger.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/asm/api-ref/public_sys-resources/icon-huawei.gif
Normal file
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/asm/api-ref/public_sys-resources/icon-note.gif
Normal file
|
After Width: | Height: | Size: 983 B |
BIN
docs/asm/api-ref/public_sys-resources/icon-notice.gif
Normal file
|
After Width: | Height: | Size: 962 B |
BIN
docs/asm/api-ref/public_sys-resources/icon-tip.gif
Normal file
|
After Width: | Height: | Size: 879 B |
BIN
docs/asm/api-ref/public_sys-resources/icon-warning.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/asm/api-ref/public_sys-resources/note_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
docs/asm/api-ref/public_sys-resources/notice_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
BIN
docs/asm/api-ref/public_sys-resources/warning_3.0-en-us.png
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
@ -1,7 +1,7 @@
|
||||
<a name="AddVaultResource"></a><a name="AddVaultResource"></a>
|
||||
|
||||
<h1 class="topictitle1">Associating Resources</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to associate resources with a vault.</p>
|
||||
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to associate resources with a vault.</p>
|
||||
</div>
|
||||
<div class="section" id="AddVaultResource__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v3/{project_id}/vaults/{vault_id}/addresources</p>
|
||||
|
||||
@ -54,7 +54,8 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -162,19 +163,19 @@
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddVaultResource__response_VaultAddResourceResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AddVaultResource__response_VaultAddResourceResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>add_resource_ids</p>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>add_resource_ids</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>List of resource IDs that have been added</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>List of resource IDs that have been added</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -220,7 +221,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Vaults</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Vaults</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<a name="AssociateVaultPolicy"></a><a name="AssociateVaultPolicy"></a>
|
||||
|
||||
<h1 class="topictitle1">Applying a Policy to a Vault</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to apply a policy to a vault.</p>
|
||||
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to apply a policy to a vault.</p>
|
||||
</div>
|
||||
<div class="section" id="AssociateVaultPolicy__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v3/{project_id}/vaults/{vault_id}/associatepolicy</p>
|
||||
|
||||
@ -54,7 +54,8 @@
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>User token</p>
|
||||
<p>The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong>X-Subject-Token</strong> in the response header is the user token.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -86,45 +87,45 @@
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AssociateVaultPolicy__response_VaultAssociateResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="AssociateVaultPolicy__response_VaultAssociateResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>associate_policy</p>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>associate_policy</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p><a href="#AssociateVaultPolicy__response_VaultPolicyResp">VaultPolicyResp</a> object</p>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p><a href="#AssociateVaultPolicy__response_VaultPolicyResp">VaultPolicyResp</a> object</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Details of applying a policy to a vault</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Details of applying a policy to a vault</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><a name="AssociateVaultPolicy__response_VaultPolicyResp"></a><a name="response_VaultPolicyResp"></a><table cellpadding="4" cellspacing="0" summary="" id="AssociateVaultPolicy__response_VaultPolicyResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VaultPolicyResp</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
||||
<div class="tablenoborder"><a name="AssociateVaultPolicy__response_VaultPolicyResp"></a><a name="response_VaultPolicyResp"></a><table cellpadding="4" cellspacing="0" summary="" id="AssociateVaultPolicy__response_VaultPolicyResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VaultPolicyResp</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p>Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>policy_id</p>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>policy_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Configured policy ID</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Configured policy ID</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>vault_id</p>
|
||||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p>vault_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Vault ID for configuring the policy ID</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Vault ID for configuring the policy ID</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -167,7 +168,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000005.html">Vaults</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Vaults</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@ -1,7 +1,14 @@
|
||||
<a name="BatchCreateAndDeleteVaultTags"></a><a name="BatchCreateAndDeleteVaultTags"></a>
|
||||
|
||||
<h1 class="topictitle1">Batch Adding or Deleting Tags of a Vault</h1>
|
||||
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to batch add or delete tags for a specified instance. TMS uses this API to manage service resource tags. A resource can have a maximum of 20 tags. This API is idempotent. If there are duplicate keys in the request body when you add tags, an error is reported. If a to-be-added tag has the same key as an existing tag, the tag will be added and will overwrite the existing tag. When deleting tags, duplicate keys are allowed. When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can each consist of up to 127 and 255 characters. When you delete tags, the tags structure cannot be missing, and the key cannot be left blank or be an empty string.</p>
|
||||
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to batch add or delete tags for a specified instance.</p>
|
||||
<p>TMS uses this API to manage service resource tags.</p>
|
||||
<p>A resource can have a maximum of 20 tags.</p>
|
||||
<p>This API is idempotent.</p>
|
||||
<p>If there are duplicate keys in the request body when you add tags, an error is reported.</p>
|
||||
<p>If a to-be-added tag has the same key as an existing tag, the tag will be added and will overwrite the existing tag.</p>
|
||||
<p>When deleting tags, duplicate keys are allowed.</p>
|
||||
<p>When deleting tags, if some tags do not exist, the deletion is considered to be successful by default. The character set of the tags will not be verified. A key and a value can each consist of up to 127 and 255 characters. When you delete tags, the tags structure cannot be missing, and the key cannot be left blank or be an empty string.</p>
|
||||
</div>
|
||||
<div class="section" id="BatchCreateAndDeleteVaultTags__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v3/{project_id}/vault/{vault_id}/tags/action</p>
|
||||
|
||||
@ -122,26 +129,26 @@
|
||||
</div>
|
||||
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 400</strong></p>
|
||||
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchCreateAndDeleteVaultTags__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchCreateAndDeleteVaultTags__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p>Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>error_code</p>
|
||||
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>error_code</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>error_msg</p>
|
||||
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>error_msg</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||||
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Error message</p>
|
||||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Error message</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -190,7 +197,7 @@
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Tags</a></div>
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Tags</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||