vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/config/api-ref/rms_04_0501.html
Wei, Hongmin da6ca4fb3c Config API First Version 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2024-08-22 10:49:27 +00:00

528 lines
35 KiB
HTML
Raw Blame History

<a name="rms_04_0501"></a><a name="rms_04_0501"></a>
<h1 class="topictitle1">Querying All Built-in Policies</h1>
<div id="body552597668"><div class="section" id="rms_04_0501__section9526127869"><h4 class="sectiontitle">Function</h4><p id="rms_04_0501__p12529877614">This API is used to query all built-in policies.</p>
</div>
<div class="section" id="rms_04_0501__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0501__p175351971168">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
</div>
<div class="section" id="rms_04_0501__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0501__p18540876616">GET /v1/resource-manager/policy-definitions</p>
</div>
<div class="section" id="rms_04_0501__section12542137268"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0501__row13547876614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0501__p1855311710610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="rms_04_0501__p145561071467">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="rms_04_0501__p19558577611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="rms_04_0501__p105611274617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row054716716614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0501__p8563971267">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0501__p10566874618">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0501__p1956813717617">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0501__p8217721115915">Language of the returned message.</p>
<p id="rms_04_0501__p834520331955">Default: <strong id="rms_04_0501__b1943184110512">en-us</strong></p>
</td>
</tr>
<tr id="rms_04_0501__row1854767268"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0501__p25793718617">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0501__p125821878611">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0501__p165851971464">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0501__p4588371765">Specifies the invoker's token.</p>
</td>
</tr>
<tr id="rms_04_0501__row65471711615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0501__p3590177367">X-Security-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rms_04_0501__p1759313715612">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0501__p14595167661">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0501__p25981371169">Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0501__section196041778612"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0501__p7607137464"><strong id="rms_04_0501__b96081711617">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_PolicyDefinitionListResult" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0501__row106090715615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0501__p14613147266">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="rms_04_0501__p761611719613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="rms_04_0501__p15619167762">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row960997561"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0501__p186221172611">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0501__p262420719614">Array of <a href="#rms_04_0501__response_PolicyDefinition">PolicyDefinition</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0501__p76271671565">Specifies the policy definition list.</p>
</td>
</tr>
<tr id="rms_04_0501__row16091279618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0501__p126301971764">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0501__p206325718617"><a href="#rms_04_0501__response_PageInfo">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0501__p136355718620">Specifies the pagination object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0501__response_PolicyDefinition"></a><a name="response_PolicyDefinition"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_PolicyDefinition" frame="border" border="1" rules="all"><caption><b>Table 3 </b>PolicyDefinition</caption><thead align="left"><tr id="rms_04_0501__row763867562"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="rms_04_0501__p1642471760">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="rms_04_0501__p156451672620">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="rms_04_0501__p19648877619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row186388712620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p96511078616">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p965418711620">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p8656271566">Specifies the policy ID.</p>
</td>
</tr>
<tr id="rms_04_0501__row14638137566"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p66591671611">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p16617716615">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p1366527760">Specifies the policy name.</p>
</td>
</tr>
<tr id="rms_04_0501__row5638670610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p156670718613">display_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p067018715610">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p8672071869">Specifies the policy display name.</p>
</td>
</tr>
<tr id="rms_04_0501__row1163867561"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p567412710614">policy_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p116772712613">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p18681187166">Specifies the policy type.</p>
</td>
</tr>
<tr id="rms_04_0501__row7638779615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p468367969">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p126861679619">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p186881371469">Specifies the description of the policy definition.</p>
</td>
</tr>
<tr id="rms_04_0501__row1263867964"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p869197367">policy_rule_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p10694127261">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p1269716712619">Specifies the syntax type of the policy.</p>
</td>
</tr>
<tr id="rms_04_0501__row3638371361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p1869977769">policy_rule</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p47021873619">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p1670427969">Specifies the policy rule.</p>
</td>
</tr>
<tr id="rms_04_0501__row11638371611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p27071671863">trigger_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p971027362">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p167131471613">Specifies the trigger type. The value can be <strong id="rms_04_0501__b1780014512481">resource</strong> or <strong id="rms_04_0501__b1480075194817">period</strong>.</p>
</td>
</tr>
<tr id="rms_04_0501__row5639771767"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p16715571862">keywords</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p15718171361">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p672027260">Specifies keywords.</p>
</td>
</tr>
<tr id="rms_04_0501__row19639976619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p2072214717611">default_resource_types</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p67251579615">Array of <a href="#rms_04_0501__response_default_resource_types">default_resource_types</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p87291275616">Specifies the list of default resource types.</p>
</td>
</tr>
<tr id="rms_04_0501__row1263918717617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="rms_04_0501__p1973113719615">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="rms_04_0501__p373418715614">Map&lt;String,<a href="#rms_04_0501__response_PolicyParameterDefinition">PolicyParameterDefinition</a>&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="rms_04_0501__p14737771063">Specifies the policy parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0501__response_default_resource_types"></a><a name="response_default_resource_types"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_default_resource_types" frame="border" border="1" rules="all"><caption><b>Table 4 </b>default_resource_types</caption><thead align="left"><tr id="rms_04_0501__row12739471067"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="rms_04_0501__p117442077610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="rms_04_0501__p117461378613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="rms_04_0501__p1074827463">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row167391773611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0501__p1575147464">provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0501__p9753971367">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0501__p37551475615">Specifies the cloud service name.</p>
</td>
</tr>
<tr id="rms_04_0501__row573957664"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0501__p27587716610">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0501__p137611875620">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0501__p97639715614">Specifies the resource type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0501__response_PolicyParameterDefinition"></a><a name="response_PolicyParameterDefinition"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_PolicyParameterDefinition" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PolicyParameterDefinition</caption><thead align="left"><tr id="rms_04_0501__row117661771165"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="rms_04_0501__p12771117766">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="rms_04_0501__p877317711613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="rms_04_0501__p277620716616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row7766137168"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p8779107164">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p6781571666">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p1978412718613">Specifies the name of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row67661271065"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p127861871163">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p6788471615">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p57915714616">Specifies the description of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row19766071660"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p1079315718619">allowed_values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p87961475610">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p97991678617">Specifies the allowed values of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row7766571761"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p580118715613">default_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p148059714616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p1980716717616">Specifies the default value of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row1076618713614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p5810371963">minimum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p48134712618">Float</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p118152071963">Specifies the minimum value of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row47671578612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p1981737264">maximum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p48201472613">Float</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p14822071464">Specifies the maximum value of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row18767147261"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p16826117169">min_items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p19829471768">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p88319714613">Specifies the minimum number of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row117671371169"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p6834471569">max_items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p28371271620">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p8839471610">Specifies the maximum number of the policy parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row276737767"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p1284257762">min_length</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p48451977612">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p10847271067">Specifies the minimum string length for policy parameters or for each item.</p>
</td>
</tr>
<tr id="rms_04_0501__row207671271613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p3849475610">max_length</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p285215713613">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p6856127766">Specifies the maximum string length for policy parameters or for each item.</p>
</td>
</tr>
<tr id="rms_04_0501__row10767271662"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p148581679614">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p486007569">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p686313718610">Specifies the pattern for policy parameters or for each item.</p>
</td>
</tr>
<tr id="rms_04_0501__row18767197561"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="rms_04_0501__p188651379620">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="rms_04_0501__p138691271569">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="rms_04_0501__p188711970612">Specifies the type of the policy parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0501__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PageInfo</caption><thead align="left"><tr id="rms_04_0501__row198749711615"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="rms_04_0501__p487818711616">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="rms_04_0501__p5881673611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="rms_04_0501__p178831473612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row187419714620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0501__p68865714615">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0501__p288927468">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0501__p13891971064">Specifies the resource quantity on the current page.</p>
<p id="rms_04_0501__p389427365">Minimum: <strong id="rms_04_0501__b16895678613">0</strong></p>
<p id="rms_04_0501__p12897071768">Maximum: <strong id="rms_04_0501__b18982071262">200</strong></p>
</td>
</tr>
<tr id="rms_04_0501__row15874978613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0501__p149016716617">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0501__p4903171268">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0501__p190615716615">Specifies the <strong id="rms_04_0501__b5908187762">marker</strong> value of the next page.</p>
<p id="rms_04_0501__p18909197462">Minimum: <strong id="rms_04_0501__b1991017715611">4</strong></p>
<p id="rms_04_0501__p3912971065">Maximum: <strong id="rms_04_0501__b189137717619">400</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0501__p15914471765"><strong id="rms_04_0501__b1891618716611">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0501__row199171672065"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="rms_04_0501__p11921577620">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="rms_04_0501__p59231076620">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="rms_04_0501__p19262717619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row14917147667"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0501__p18929177163">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0501__p1393210714618">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0501__p6935187666">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0501__row691757862"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0501__p593717865">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0501__p18939571764">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0501__p18942471063">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0501__p7945171864"><strong id="rms_04_0501__b294677160">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_ErrorResp_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0501__row994718713618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="rms_04_0501__p195577164">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="rms_04_0501__p16958471363">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="rms_04_0501__p59605719618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row694787464"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0501__p17963671261">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0501__p159651173617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0501__p18967197261">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0501__row594707862"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="rms_04_0501__p89701576613">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="rms_04_0501__p8972774615">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="rms_04_0501__p097537464">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0501__p297718719612"><strong id="rms_04_0501__b109799711613">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_ErrorResp_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0501__row18980471963"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="rms_04_0501__p16984107763">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="rms_04_0501__p119865720611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="rms_04_0501__p13989771367">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row189805718617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="rms_04_0501__p12992127061">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="rms_04_0501__p399527667">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="rms_04_0501__p1299767968">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0501__row6980775617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="rms_04_0501__p607814619">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="rms_04_0501__p631281968">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="rms_04_0501__p651981569">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0501__p18716818610"><strong id="rms_04_0501__b11818812619">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__response_ErrorResp_3" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0501__row1391081363"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="rms_04_0501__p714158461">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="rms_04_0501__p111788561">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="rms_04_0501__p1519081467">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row14910820618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="rms_04_0501__p132216817613">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="rms_04_0501__p925281616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="rms_04_0501__p202878966">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0501__row210381766"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="rms_04_0501__p53038862">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="rms_04_0501__p103328668">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="rms_04_0501__p133518818616">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0501__section63858362"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="rms_04_0501__screen13197493611">GET https://{endpoint}/v1/resource-manager/policy-definitions</pre>
</div>
<div class="section" id="rms_04_0501__section12441881262"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0501__p12471788610"><strong id="rms_04_0501__b12481182615">Status code: 200</strong></p>
<p id="rms_04_0501__p1949581615">Operation succeeded.</p>
<pre class="screen" id="rms_04_0501__screen265273319163">{
"value" : [ {
"id" : "5fa365476eed194ccb2c04d1",
"name" : "volumes-encrypted-check",
"display_name" : "Enable encryption for the attached EVS volumes.",
"policy_type" : "builtin",
"description" : "An EVS disk is non-compliant if it has been mounted but not encrypted.",
"policy_rule_type" : "dsl",
"policy_rule" : {
"allOf" : [ {
"value" : "${resource().provider}",
"comparator" : "equals",
"pattern" : "evs"
}, {
"value" : "${resource().type}",
"comparator" : "equals",
"pattern" : "volumes"
}, {
"value" : "${resource().properties.status}",
"comparator" : "equals",
"pattern" : "in-use"
}, {
"anyOf" : [ {
"value" : "${resource().properties.metadata}",
"comparator" : "notContainsKey",
"pattern" : "systemEncrypted"
}, {
"value" : "${resource().properties.metadata.systemEncrypted}",
"comparator" : "equals",
"pattern" : "0"
} ]
} ]
},
"keywords" : [ "evs", "ecs" ],
"parameters" : { }
} ],
"page_info" : {
"current_count" : 1,
"next_marker" : null
}
}</pre>
<div class="note" id="rms_04_0501__note14734110163217"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rms_04_0501__p109671231582"><strong id="rms_04_0501__b5453174593218">allOf</strong> and <strong id="rms_04_0501__b1422718487326">anyOf</strong> in the response example are logical operators. The following describes these two operators in detail:</p>
<p id="rms_04_0501__p2771418332"><strong id="rms_04_0501__b970191414336">allOf</strong> evaluates true only if all included conditions are true, and evaluates false as long as one included condition is false.</p>
<p id="rms_04_0501__p1278174183315"><strong id="rms_04_0501__b1280641643310">anyOf</strong> evaluates true as long as one included condition is true, and evaluates false if all included conditions are false.</p>
<p id="rms_04_0501__p1786414336"><strong id="rms_04_0501__b13304102193319">allOf</strong> and <strong id="rms_04_0501__b588482519333">anyOf</strong> both implement short-circuit evaluation. They evaluate the conditions in the subsequent list in sequence.</p>
<p id="rms_04_0501__p157810419336">If the return result of a condition is false, <strong id="rms_04_0501__b587023463318">allOf</strong> returns false and the subsequent conditions are not calculated.</p>
<p id="rms_04_0501__p14784423313">If the return result of a condition is true, <strong id="rms_04_0501__b763173733319">anyOf</strong> returns true and the subsequent conditions are not calculated.</p>
</div></div>
</div>
<div class="section" id="rms_04_0501__section1524111161610"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0501__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0501__row96161882068"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0501__p22441716460">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="rms_04_0501__p1724511168616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0501__row561617816616"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0501__p11246111610616">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0501__p824771618610">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_04_0501__row14617181969"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0501__p16248171618612">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0501__p42497162611">Invalid parameter.</p>
</td>
</tr>
<tr id="rms_04_0501__row06171786615"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0501__p112501716662">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0501__p0251516964">Authentication failed or you do not have the operation permissions.</p>
</td>
</tr>
<tr id="rms_04_0501__row6617148863"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0501__p125271618611">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0501__p1725315161069">Resources not found.</p>
</td>
</tr>
<tr id="rms_04_0501__row96171581465"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0501__p16254516666">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0501__p1425511161661">Server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0501__section72562016366"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0501__p122581516269">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rms_04_0500.html">Compliance</a></div>
</div>
</div>
View Git Blame Copy Permalink