forked from docs/doc-exports
Wei, Hongmin
c7cf8ac24f
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>
243 lines
15 KiB
HTML
243 lines
15 KiB
HTML
<a name="iam_02_0028"></a><a name="iam_02_0028"></a>
|
|
|
|
<h1 class="topictitle1">Querying the ACL for Console Access</h1>
|
|
<div id="body1597737539340"><div class="section" id="iam_02_0028__section20991534172015"><h4 class="sectiontitle">Function</h4><p id="iam_02_0028__p1117233416200">This API is used to query the ACL for console access.</p>
|
|
</div>
|
|
<div class="section" id="iam_02_0028__section12991234162011"><h4 class="sectiontitle">URI</h4><p id="iam_02_0028__p11172634142010">GET /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/console-acl-policy</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table1499203417209" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_02_0028__row91721134162018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_02_0028__p111721434192016">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_0028__p6172113412206">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_0028__p6172113472013">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_0028__p13172034142015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row417273412206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_02_0028__p317212345201">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_02_0028__p1172123472011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_02_0028__p217219345204">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_02_0028__p71721034192017">Domain ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_02_0028__section4102173402012"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table16102934122014" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_02_0028__row91721734142011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_02_0028__p1417218345201">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_0028__p2017293411203">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_0028__p191725343207">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_0028__p3172334142018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row14172934132013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_02_0028__p171724347203">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_0028__p2172193482011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_02_0028__p141721434192020">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_02_0028__p11721134202016">Token with <strong id="iam_02_0028__b39791393477">Security Administrator</strong> permissions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_02_0028__section7104143422014"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table13105133462010" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_02_0028__row417283416206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="iam_02_0028__p19172193452020">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_0028__p8172113442014">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_0028__p1317293416200">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row717316345204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="iam_02_0028__p717313342204"><a href="#iam_02_0028__table1910743413202">console_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_0028__p11173834172020">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="iam_02_0028__p10173534192019">ACL for console access.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_02_0028__table1910743413202"></a><a name="table1910743413202"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table1910743413202" frame="border" border="1" rules="all"><caption><b>Table 4 </b>console_acl_policy</caption><thead align="left"><tr id="iam_02_0028__row517314343200"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_02_0028__p16173173419203">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_0028__p14173113413203">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_0028__p16173173419207">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row917393415206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0028__p191731434162019"><a href="#iam_02_0028__table201101534172012">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_0028__p517383413209">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0028__p13173103418202">IPv4 CIDR blocks from which console access is allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row101731034102014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0028__p1117333420203"><a href="#iam_02_0028__table10112234152017">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_0028__p1428973642918">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0028__p15173163412203">IP address ranges from which console access is allowed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_02_0028__table201101534172012"></a><a name="table201101534172012"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table201101534172012" frame="border" border="1" rules="all"><caption><b>Table 5 </b>allow_address_netmasks</caption><thead align="left"><tr id="iam_02_0028__row1017343410209"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_02_0028__p81731234182011">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_0028__p18173113417201">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_0028__p8173534122011">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row41731434102018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0028__p19173113414202">address_netmask</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0028__p1517343416208">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0028__p1017313414202">IPv4 CIDR block, for example, <strong id="iam_02_0028__b8102114192510">192.168.0.1/24</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row11173734132015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_02_0028__p14173534172013">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_02_0028__p7173103411202">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_02_0028__p18173153402020">Description about the IPv4 CIDR block.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_02_0028__table10112234152017"></a><a name="table10112234152017"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table10112234152017" frame="border" border="1" rules="all"><caption><b>Table 6 </b>allow_ip_ranges</caption><thead align="left"><tr id="iam_02_0028__row017353462019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="iam_02_0028__p6173113412019">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_0028__p01731434172013">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_0028__p21734348207">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row7173143419206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_02_0028__p171731634152019">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_02_0028__p917318346207">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_02_0028__p917320349202">Description about an IP address range.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row14173334122010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_02_0028__p9173123419202">ip_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_02_0028__p1817315344208">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_02_0028__p1617315347205">IP address range, for example, <strong id="iam_02_0028__b434820277257">0.0.0.0-255.255.255.255</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_02_0028__section1311410345203"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_02_0028__screen1017383410203">GET https://sample.domain.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/console-acl-policy</pre>
|
|
</div>
|
|
<div class="section" id="iam_02_0028__section21151234122011"><h4 class="sectiontitle">Example Response</h4><p id="iam_02_0028__p161735347206"><strong id="iam_02_0028__b114113118253">Status code: 200</strong></p>
|
|
<p id="iam_02_0028__p2017317344201">The request is successful.</p>
|
|
<pre class="screen" id="iam_02_0028__screen11173143413206">{
|
|
"console_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_0028__p867419559296"><strong id="iam_02_0028__b1729313319253">Status code: 403</strong></p>
|
|
<p id="iam_02_0028__p146742556299">Access denied.</p>
|
|
<ul id="iam_02_0028__ul15674185592919"><li id="iam_02_0028__li16741055142918">Example 1</li></ul>
|
|
<pre class="screen" id="iam_02_0028__screen595885982912">{
|
|
"error_msg" : "You are not authorized to perform the requested action.",
|
|
"error_code" : "IAM.0002"
|
|
}</pre>
|
|
<ul id="iam_02_0028__ul223617153014"><li id="iam_02_0028__li82368117306">Example 2</li></ul>
|
|
<pre class="screen" id="iam_02_0028__screen119821652301">{
|
|
"error_msg" : "Policy doesn't allow %(actions)s to be performed.",
|
|
"error_code" : "IAM.0003"
|
|
}</pre>
|
|
<p id="iam_02_0028__p5674155516297"><strong id="iam_02_0028__b5796133814256">Status code: 404</strong></p>
|
|
<p id="iam_02_0028__p1467485511294">The requested resource cannot be found.</p>
|
|
<pre class="screen" id="iam_02_0028__screen146741855202912">{
|
|
"error_msg" : "Could not find %(target)s: %(target_id)s.",
|
|
"error_code" : "IAM.0004"
|
|
}</pre>
|
|
<p id="iam_02_0028__p967425513292"><strong id="iam_02_0028__b15848204012514">Status code: 500</strong></p>
|
|
<p id="iam_02_0028__p9674185592914">Internal server error.</p>
|
|
<pre class="screen" id="iam_02_0028__screen166745553297">{
|
|
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
|
|
"error_code" : "IAM.0006"
|
|
}</pre>
|
|
<div class="section" id="iam_02_0028__section51183348200"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0028__table811843411203" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0028__row11173153422019"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.19.2.1.3.1.1"><p id="iam_02_0028__p12173123415202">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.19.2.1.3.1.2"><p id="iam_02_0028__p1117312340209">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0028__row11173113492011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0028__p6173163412204">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0028__p017373442014">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row1817310343203"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0028__p171731534132014">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0028__p1417318341205">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row11731234132011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0028__p81731134152014">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0028__p191731334122019">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row11731834102013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0028__p817363402019">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0028__p191741134152011">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0028__row181741134102017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0028__p71747348207">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0028__p61741534172019">Internal server error.</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>
|
|
|