vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/iam/api-ref/iam_02_0029.html
Wei, Hongmin c7cf8ac24f IAM API 0711 Version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2024-07-11 11:57:45 +00:00

375 lines
24 KiB
HTML
Raw Blame History

<a name="iam_02_0029"></a><a name="iam_02_0029"></a>
<h1 class="topictitle1">Modifying the ACL for API Access</h1>
<div id="body1597737539340"><div class="section" id="iam_02_0029__section1648844162017"><h4 class="sectiontitle">Function</h4><p id="iam_02_0029__p18777104462012">This API is provided for the administrator to modify the ACL for API access.</p>
</div>
<div class="section" id="iam_02_0029__section364814482011"><h4 class="sectiontitle">URI</h4><p id="iam_02_0029__p1677754415207">PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policy</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table7648134442014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_02_0029__row977754492020"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_02_0029__p16777174442014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_02_0029__p207771244192010">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_02_0029__p877774410204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_02_0029__p14777134432017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row14777154415203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_02_0029__p1177713445202">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_02_0029__p177771144182011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_02_0029__p14777134416208">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_02_0029__p9777154432012">Domain ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_02_0029__section11651744182013"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table1065213447201" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_02_0029__row11777104419209"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_02_0029__p177771944162010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_02_0029__p19777744162016">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_02_0029__p17771644182018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_02_0029__p4777194415205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row17777144122020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_02_0029__p117771244182017">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_02_0029__p7777104417203">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_02_0029__p18777124417204">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_02_0029__p577774417206">Token with <strong id="iam_02_0029__b139081593479">Security Administrator</strong> permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table36541044172012" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_02_0029__row117771544112011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_02_0029__p377784422015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_02_0029__p8777154432010">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_02_0029__p07771244102020">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_02_0029__p5777134411205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row1377774411207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_02_0029__p1077794442019"><a href="#iam_02_0029__table165615447201">api_acl_policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_02_0029__p1777114419202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_02_0029__p4777444142017">object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_02_0029__p1577754452019">ACL for API access.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_02_0029__table165615447201"></a><a name="table165615447201"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table165615447201" frame="border" border="1" rules="all"><caption><b>Table 4 </b>api_acl_policy</caption><thead align="left"><tr id="iam_02_0029__row8777204415206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_02_0029__p2077794442011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.4.2.5.1.2"><p id="iam_02_0029__p117771644172016">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="iam_02_0029__p977710445202">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.4.2.5.1.4"><p id="iam_02_0029__p87771448205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row1577754412208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0029__p2777164410206"><a href="#iam_02_0029__table6660124414208">allow_address_netmasks</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0029__p107771944142011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0029__p137779442203">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0029__p139881528183110">IPv4 CIDR blocks from which API access is allowed.</p>
</td>
</tr>
<tr id="iam_02_0029__row11777204418203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0029__p277717449202"><a href="#iam_02_0029__table1663444182011">allow_ip_ranges</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0029__p877710442207">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0029__p377764412205">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0029__p2080119424473">IP address ranges from which API access is allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_02_0029__table6660124414208"></a><a name="table6660124414208"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table6660124414208" frame="border" border="1" rules="all"><caption><b>Table 5 </b>allow_address_netmasks</caption><thead align="left"><tr id="iam_02_0029__row87771544192010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="iam_02_0029__p577734414201">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.5.2.5.1.2"><p id="iam_02_0029__p117771944152010">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="iam_02_0029__p67772447207">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.5.2.5.1.4"><p id="iam_02_0029__p17777744152019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row15777204422013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="iam_02_0029__p13777184415202">address_netmask</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.2 "><p id="iam_02_0029__p1077724442014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="iam_02_0029__p6777744122018">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.5.1.4 "><p id="iam_02_0029__p107771344162018">IPv4 CIDR block, for example, <strong id="iam_02_0029__b97850152619">192.168.0.1/24</strong>.</p>
</td>
</tr>
<tr id="iam_02_0029__row4777164420205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="iam_02_0029__p777713449209">description</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.2 "><p id="iam_02_0029__p167772446207">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="iam_02_0029__p12777194422018">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.5.1.4 "><p id="iam_02_0029__p1277764452010">Description about the IPv4 CIDR block.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_02_0029__table1663444182011"></a><a name="table1663444182011"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table1663444182011" frame="border" border="1" rules="all"><caption><b>Table 6 </b>allow_ip_ranges</caption><thead align="left"><tr id="iam_02_0029__row177724417207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="iam_02_0029__p13777134417206">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.6.2.5.1.2"><p id="iam_02_0029__p077774452018">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="iam_02_0029__p17777164411209">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.6.2.5.1.4"><p id="iam_02_0029__p19777844122010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row1077874413202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="iam_02_0029__p6778124419203">description</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.2 "><p id="iam_02_0029__p87781744172016">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="iam_02_0029__p14778164422014">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.6.2.5.1.4 "><p id="iam_02_0029__p97781944132013">Description about an IP address range.</p>
</td>
</tr>
<tr id="iam_02_0029__row5778204472011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="iam_02_0029__p1977864482010">ip_range</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.2 "><p id="iam_02_0029__p977816446204">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="iam_02_0029__p77783447206">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.6.2.5.1.4 "><p id="iam_02_0029__p19778444182010">IP address range, for example, <strong id="iam_02_0029__b125340114270">0.0.0.0-255.255.255.255</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_02_0029__section86661144162010"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table76671144102011" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_02_0029__row077844482012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="iam_02_0029__p877874492010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.2"><p id="iam_02_0029__p157781844122019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.2.4.1.3"><p id="iam_02_0029__p877834402016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row87781944182018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="iam_02_0029__p57785441204"><a href="#iam_02_0029__table9669844112020">api_acl_policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="iam_02_0029__p147782044202010">object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="iam_02_0029__p17783444201">ACL for API access.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_02_0029__table9669844112020"></a><a name="table9669844112020"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table9669844112020" frame="border" border="1" rules="all"><caption><b>Table 8 </b>api_acl_policy</caption><thead align="left"><tr id="iam_02_0029__row11778144132016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_02_0029__p4778124432012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_02_0029__p1977816446200">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_02_0029__p147781744112018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row977819444207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0029__p12778124422012"><a href="#iam_02_0029__table06721944162013">allow_address_netmasks</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0029__p177781444132016">objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0029__p945283083212">IPv4 CIDR blocks from which API access is allowed.</p>
</td>
</tr>
<tr id="iam_02_0029__row1777814442204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0029__p677804492012"><a href="#iam_02_0029__table1663444182011">allow_ip_ranges</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0029__p167781644152018">objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0029__p16452183017320">IP address ranges from which API access is allowed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_02_0029__table06721944162013"></a><a name="table06721944162013"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table06721944162013" frame="border" border="1" rules="all"><caption><b>Table 9 </b>allow_address_netmasks</caption><thead align="left"><tr id="iam_02_0029__row12778164419207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_02_0029__p19778184492010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="iam_02_0029__p1677854472013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="iam_02_0029__p147783442202">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row14778164412201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0029__p1377854482012">address_netmask</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0029__p147781444172011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0029__p9855736143213">IPv4 CIDR block, for example, <strong id="iam_02_0029__b135525259278">192.168.0.1/24</strong>.</p>
</td>
</tr>
<tr id="iam_02_0029__row1177815442203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0029__p147781344122020">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0029__p14778174442019">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0029__p6855143620329">Description about the IPv4 CIDR block.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table1567554416203" frame="border" border="1" rules="all"><caption><b>Table 10 </b>allow_ip_ranges</caption><thead align="left"><tr id="iam_02_0029__row1877844472010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="iam_02_0029__p16778644142014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="iam_02_0029__p137781244192016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="iam_02_0029__p1677813443207">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row18778104417202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_02_0029__p777854472020">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_02_0029__p9778124412017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_02_0029__p6923154011321">Description about an IP address range.</p>
</td>
</tr>
<tr id="iam_02_0029__row157781144192017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_02_0029__p17778174419207">ip_range</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_02_0029__p18778044172011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_02_0029__p159231040133213">IP address range, for example, <strong id="iam_02_0029__b681184162718">0.0.0.0-255.255.255.255</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_02_0029__section76771744152017"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_02_0029__screen177864418206">PUT https://sample.domain.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/api-acl-policy
{
"api_acl_policy" : {
"allow_ip_ranges" : [ {
"ip_range" : "0.0.0.0-255.255.255.255",
"description" : "1"
}, {
"ip_range" : "0.0.0.0-255.255.255.253",
"description" : "12"
} ],
"allow_address_netmasks" : [ {
"address_netmask" : "192.168.0.1/24",
"description" : "3"
}, {
"address_netmask" : "192.168.0.2/23",
"description" : "4"
} ]
}
}</pre>
</div>
<div class="section" id="iam_02_0029__section1867834413209"><h4 class="sectiontitle">Example Response</h4><p id="iam_02_0029__p1277814412203"><strong id="iam_02_0029__b126111944192719">Status code: 200</strong></p>
<p id="iam_02_0029__p11778164442012">The request is successful.</p>
<pre class="screen" id="iam_02_0029__screen10778114415208">{
"api_acl_policy" : {
"allow_ip_ranges" : [ {
"ip_range" : "0.0.0.0-255.255.255.255",
"description" : ""
}, {
"ip_range" : "0.0.0.0-255.255.255.255",
"description" : ""
} ],
"allow_address_netmasks" : [ {
"address_netmask" : "192.168.0.1/24",
"description" : ""
}, {
"address_netmask" : "192.168.0.1/24",
"description" : ""
} ]
}
}</pre>
</div>
<p id="iam_02_0029__p1243183473311"><strong id="iam_02_0029__b725010460276">Status code: 400</strong></p>
<p id="iam_02_0029__p243183419338">The request body is abnormal.</p>
<ul id="iam_02_0029__ul943119344336"><li id="iam_02_0029__li1543123463315">Example 1</li></ul>
<pre class="screen" id="iam_02_0029__screen6347203919339">{
"error_msg" : "'%(key)s' is a required property.",
"error_code" : "IAM.0072"
}</pre>
<ul id="iam_02_0029__ul8704104033311"><li id="iam_02_0029__li11704204013337">Example 2</li></ul>
<pre class="screen" id="iam_02_0029__screen1384134483316">{
"error_msg" : "Invalid input for field '%(key)s'. The value is '%(value)s'.",
"error_code" : "IAM.0073"
}</pre>
<p id="iam_02_0029__p34314348337"><strong id="iam_02_0029__b848064912710">Status code: 500</strong></p>
<p id="iam_02_0029__p943133411336">The system is abnormal.</p>
<pre class="screen" id="iam_02_0029__screen4431834153312">{
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
"error_code" : "IAM.0006"
}</pre>
<div class="section" id="iam_02_0029__section36814447201"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0029__table1468194422011" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0029__row57791844102012"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.16.2.1.3.1.1"><p id="iam_02_0029__p197791844152012">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.16.2.1.3.1.2"><p id="iam_02_0029__p177791444152020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0029__row197791644142012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.16.2.1.3.1.1 "><p id="iam_02_0029__p1477919448200">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.16.2.1.3.1.2 "><p id="iam_02_0029__p477964472013">The request is successful.</p>
</td>
</tr>
<tr id="iam_02_0029__row277914492016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.16.2.1.3.1.1 "><p id="iam_02_0029__p1377914412201">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.16.2.1.3.1.2 "><p id="iam_02_0029__p197795441202">The request body is abnormal.</p>
</td>
</tr>
<tr id="iam_02_0029__row47791844132013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.16.2.1.3.1.1 "><p id="iam_02_0029__p977994472018">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.16.2.1.3.1.2 "><p id="iam_02_0029__p177792440203">Authentication failed.</p>
</td>
</tr>
<tr id="iam_02_0029__row27791244102016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.16.2.1.3.1.1 "><p id="iam_02_0029__p5779344172014">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.16.2.1.3.1.2 "><p id="iam_02_0029__p14443175616209">Access denied.</p>
</td>
</tr>
<tr id="iam_02_0029__row8779124462012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.16.2.1.3.1.1 "><p id="iam_02_0029__p1677994412013">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.16.2.1.3.1.2 "><p id="iam_02_0029__p4779114412010">The system is abnormal.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_02_0020.html">Security Settings</a></div>
</div>
</div>
View Git Blame Copy Permalink