vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/config/api-ref/rms_04_0515.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

478 lines
32 KiB
HTML
Raw Blame History

<a name="rms_04_0515"></a><a name="rms_04_0515"></a>
<h1 class="topictitle1">Updating the Compliance Result</h1>
<div id="body777010587452"><div class="section" id="rms_04_0515__section1577245819455"><h4 class="sectiontitle">Function</h4><p id="rms_04_0515__p7776145820458">This API is used to update the compliance result of a custom rule.</p>
</div>
<div class="section" id="rms_04_0515__atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p id="rms_04_0515__p177845585456">For details, see <a href="rms_03_0000.html">Calling APIs</a>.</p>
</div>
<div class="section" id="rms_04_0515__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="rms_04_0515__p4792145819451">PUT /v1/resource-manager/domains/{domain_id}/policy-states</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__table10800195814453" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="rms_04_0515__row1979675812453"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="rms_04_0515__p20803135820455">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="rms_04_0515__p2080615894517">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="rms_04_0515__p10810155816453">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="rms_04_0515__p7813145816456">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row679645884516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="rms_04_0515__p281815814450">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="rms_04_0515__p98227585457">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="rms_04_0515__p168253586451">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="rms_04_0515__p10829115834517">Specifies tags.</p>
<p id="rms_04_0515__p7832105816456">Maximum: <strong id="rms_04_0515__b8835195874511">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0515__section08381858194513"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rms_04_0515__row2084213583450"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="rms_04_0515__p10847125813451">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_0515__p885165817456">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_0515__p15856185812452">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_0515__p68621158124510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row684235814459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0515__p1867145818453">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_0515__p98707584454">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0515__p28741558134517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0515__p1787835874518">Specifies the invoker's token.</p>
</td>
</tr>
<tr id="rms_04_0515__row584225824519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rms_04_0515__p138821058184512">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_0515__p158861158134517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rms_04_0515__p389116581451">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rms_04_0515__p6895115844514">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 class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__request_PolicyStateRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="rms_04_0515__row289985818454"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="rms_04_0515__p9905258184515">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="rms_04_0515__p99101458104512">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="rms_04_0515__p13914145818454">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="rms_04_0515__p1917165844519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row58994581456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p1692235815455">policy_resource</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p79261758104513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p17930658194517"><a href="#rms_04_0515__request_PolicyResource">PolicyResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p393485874520">Specifies the resource.</p>
</td>
</tr>
<tr id="rms_04_0515__row989965818456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p16937758154516">trigger_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p89417587459">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p59456584456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p15948658104513">Specifies the trigger type. The value can be <strong id="rms_04_0515__b1780014512481">resource</strong> or <strong id="rms_04_0515__b1480075194817">period</strong>.</p>
</td>
</tr>
<tr id="rms_04_0515__row1489911581450"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p16952258124517">compliance_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p495545817455">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p16960155884518">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p1496410588450">Specifies the compliance status.</p>
</td>
</tr>
<tr id="rms_04_0515__row789975814456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p199671858184517">policy_assignment_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p11970458114516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p199759585452">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p397995854515">Specifies the policy rule id.</p>
</td>
</tr>
<tr id="rms_04_0515__row18899158124516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p1498211584450">policy_assignment_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p89861958164512">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p6990155815450">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p0993155813456">Specifies the policy rule name.</p>
</td>
</tr>
<tr id="rms_04_0515__row489915804510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p8997658194520">evaluation_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p19145944520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p7555910456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p12985964512">Specifies when a rule is used to evaluate the resource compliance.</p>
</td>
</tr>
<tr id="rms_04_0515__row19005588456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rms_04_0515__p612195994513">evaluation_hash</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rms_04_0515__p161655974517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rms_04_0515__p220059154515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rms_04_0515__p11242593458">Specifies the evaluation verification code.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rms_04_0515__request_PolicyResource"></a><a name="request_PolicyResource"></a><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__request_PolicyResource" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PolicyResource</caption><thead align="left"><tr id="rms_04_0515__row5279595454"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="rms_04_0515__p435145944518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="rms_04_0515__p2039195914518">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="rms_04_0515__p34215599453">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="rms_04_0515__p134695944510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row4279599456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rms_04_0515__p1450115913458">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rms_04_0515__p175435904510">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rms_04_0515__p1557175994517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rms_04_0515__p96195913457">Specifies the resource ID.</p>
</td>
</tr>
<tr id="rms_04_0515__row528959114511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rms_04_0515__p06505914456">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rms_04_0515__p1569155964512">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rms_04_0515__p372175916453">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rms_04_0515__p1477155910453">Specifies the resource name.</p>
</td>
</tr>
<tr id="rms_04_0515__row9281594454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rms_04_0515__p580145914517">resource_provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rms_04_0515__p1585135915457">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rms_04_0515__p1889155934517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rms_04_0515__p13924596455">Specifies the cloud service name.</p>
</td>
</tr>
<tr id="rms_04_0515__row13282593456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rms_04_0515__p6963594458">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rms_04_0515__p310011596457">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rms_04_0515__p1510575918457">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rms_04_0515__p2010919597455">Specifies the resource type.</p>
</td>
</tr>
<tr id="rms_04_0515__row32820593454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rms_04_0515__p4113165910457">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rms_04_0515__p171181759154518">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rms_04_0515__p1612217595455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rms_04_0515__p9126155944517">Specifies the region ID.</p>
</td>
</tr>
<tr id="rms_04_0515__row152885964520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rms_04_0515__p15131135912456">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rms_04_0515__p18135115912452">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rms_04_0515__p191399594456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rms_04_0515__p214225914515">Specifies the ID of the user to which the resource belongs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0515__section5148115934511"><h4 class="sectiontitle">Response Parameters</h4><p id="rms_04_0515__p51521659174510"><strong id="rms_04_0515__b515411597457">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__response_PolicyState" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0515__row715675915452"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="rms_04_0515__p1016235915458">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_0515__p15167165910452">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_0515__p0171175934518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row16156145924510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p141761159114514">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p18180659194514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p11184659114519">Specifies the user ID.</p>
</td>
</tr>
<tr id="rms_04_0515__row215635954517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p1818705994516">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p111911459184515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p719655915454">Specifies the ID of the region the resource belongs to.</p>
</td>
</tr>
<tr id="rms_04_0515__row2015617594453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p719905944513">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p120385934517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p20207135954512">Specifies the resource ID.</p>
</td>
</tr>
<tr id="rms_04_0515__row11156195994520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p6211859104519">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p9215185914458">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p1021814592452">Specifies the resource name.</p>
</td>
</tr>
<tr id="rms_04_0515__row7156059174517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p142223594459">resource_provider</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p19225195924514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p12229185904511">Specifies the cloud service name.</p>
</td>
</tr>
<tr id="rms_04_0515__row1815615920451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p2234185984517">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p023812596458">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p12242105944520">Specifies the resource type.</p>
</td>
</tr>
<tr id="rms_04_0515__row3156155974515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p18245125911457">trigger_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p1024910594456">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p32539594456">Specifies the trigger type. The value can be <strong id="rms_04_0515__b625512594453">resource</strong> or <strong id="rms_04_0515__b16255185944511">period</strong>.</p>
</td>
</tr>
<tr id="rms_04_0515__row51574598453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p92572599458">compliance_state</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p17262125974516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p0266145916454">Specifies the compliance status.</p>
</td>
</tr>
<tr id="rms_04_0515__row315755974514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p02713597456">policy_assignment_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p127665984515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p9280659164510">Specifies the rule ID.</p>
</td>
</tr>
<tr id="rms_04_0515__row115705984510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p328413591457">policy_assignment_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p72883596454">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p22921359144515">Specifies the rule name.</p>
</td>
</tr>
<tr id="rms_04_0515__row17157859124511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p1629512597450">policy_definition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p7298959174510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p1730395974511">Specifies the policy ID.</p>
</td>
</tr>
<tr id="rms_04_0515__row19157759124511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="rms_04_0515__p19307125964515">evaluation_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="rms_04_0515__p10310259194519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="rms_04_0515__p1231495914458">Specifies the evaluation time of compliance status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0515__p20317165911459"><strong id="rms_04_0515__b11319135994515">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0515__row18320145954510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="rms_04_0515__p83261159204513">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_0515__p103301259124518">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_0515__p8334185924516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row11320105910457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0515__p7338115918459">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0515__p10341195984513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0515__p6345205964510">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0515__row9320195911458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="rms_04_0515__p1634818590454">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="rms_04_0515__p23521659134516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="rms_04_0515__p5356105934517">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0515__p11359115918455"><strong id="rms_04_0515__b1136155917451">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__response_ErrorResp_1" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0515__row18363459184511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="rms_04_0515__p1037085915459">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_0515__p11373659164511">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_0515__p537795984512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row236311595455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0515__p9382175974512">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0515__p20385125944514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0515__p43896591459">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0515__row1936313592453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="rms_04_0515__p339213597451">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="rms_04_0515__p039695920456">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="rms_04_0515__p940016598453">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rms_04_0515__p9403115917456"><strong id="rms_04_0515__b1540585934512">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__response_ErrorResp_2" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="rms_04_0515__row12406185914451"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="rms_04_0515__p641319593452">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_0515__p1041745924520">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_0515__p184211598459">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row17406659174512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0515__p24246597453">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0515__p64298594452">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0515__p6432359114518">Specifies the error code.</p>
</td>
</tr>
<tr id="rms_04_0515__row740615918454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="rms_04_0515__p84361959134517">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="rms_04_0515__p843918599459">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="rms_04_0515__p16443155984518">Specifies the error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0515__section74471591459"><h4 class="sectiontitle">Example Requests</h4><p id="rms_04_0515__p34521595454">The reported compliance result by functionGraph is <strong id="rms_04_0515__b2045475911455">NonCompliant</strong>.</p>
<pre class="screen" id="rms_04_0515__screen8462185913458">PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-states
{
"policy_resource" : {
"domain_id" : "d0123456789",
"region_id" : "global",
"resource_id" : "abc0123456789",
"resource_name" : "test_user",
"resource_provider" : "iam",
"resource_type" : "users"
},
"trigger_type" : "resource",
"compliance_state" : "NonCompliant",
"policy_assignment_id" : "abc0123456789abc",
"policy_assignment_name" : "custom_policy",
"evaluation_time" : 1667374060248,
"evaluation_hash" : "89342b8f338165651991afb8bd471396"
}</pre>
</div>
<div class="section" id="rms_04_0515__section135214591450"><h4 class="sectiontitle">Example Responses</h4><p id="rms_04_0515__p10525165918451"><strong id="rms_04_0515__b17527105916458">Status code: 200</strong></p>
<p id="rms_04_0515__p195281359174515">Operation succeeded.</p>
<pre class="screen" id="rms_04_0515__screen18536105934511">{
"domain_id" : "d0123456789",
"region_id" : "global",
"resource_id" : "abc0123456789",
"resource_name" : "test_user",
"resource_provider" : "iam",
"resource_type" : "users",
"trigger_type" : "resource",
"compliance_state" : "NonCompliant",
"policy_assignment_id" : "abc0123456789abc",
"policy_assignment_name" : "custom_policy",
"policy_definition_id" : null,
"evaluation_time" : 1667374060248
}</pre>
<p id="rms_04_0515__p4703111613715"><strong id="rms_04_0515__b1288655235219">Status code: 400</strong></p>
<p id="rms_04_0515__p4703191663720">Operation failed.</p>
<p id="rms_04_0515__p529294625012">The following error code and message do not indicate any exceptions if they are displayed when you invoke the API based on the example request.</p>
<pre class="screen" id="rms_04_0515__screen870318169375">{
"error_code": "invalid_parameters",
"error_msg": "evaluationHash should not be customized"
}</pre>
<div class="note" id="rms_04_0515__note113274771013"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rms_04_0515__p20268133463815">A FunctionGraph function of a Config rule requires a valid <strong id="rms_04_0515__b1015518421382">evaluation_hash</strong> for it to operate normally. After a custom Config rule is triggered, Config sends an event to call the corresponding FunctionGraph function. And the FunctionGraph function obtains the <strong id="rms_04_0515__b1886084913384">evaluation_hash</strong> from the event. After obtaining the <strong id="rms_04_0515__b45821955173813">evaluation_hash</strong>, the function sends evaluation results to Config using the API.</p>
<p id="rms_04_0515__p1026813346383">In general, this API is not intended for users, but for FunctionGraph functions of Config rules. If the preceding error message is displayed when you call this API, it indicates that the FunctionGraph function has the permission to send evaluation results to Config.</p>
</div></div>
</div>
<div class="section" id="rms_04_0515__section19748220469"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rms_04_0515__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="rms_04_0515__row796013590457"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="rms_04_0515__p15762028467">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_0515__p1878132154613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rms_04_0515__row6960959154518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0515__p107912274613">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0515__p6813214462">Operation succeeded.</p>
</td>
</tr>
<tr id="rms_04_0515__row796018599453"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0515__p11829204616">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0515__p1984729463">Invalid parameters.</p>
</td>
</tr>
<tr id="rms_04_0515__row1896055918454"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0515__p1855218462">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0515__p198719212469">Authentication failed or you do not have the operation permissions.</p>
</td>
</tr>
<tr id="rms_04_0515__row896035984510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="rms_04_0515__p1788102104610">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="rms_04_0515__p88919264616">Server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rms_04_0515__section109112211463"><h4 class="sectiontitle">Error Codes</h4><p id="rms_04_0515__p20930213462">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