Updated API doc for policy_update
This commit is contained in:
parent
b9a15aeb78
commit
bb1210a0b8
@ -951,24 +951,44 @@ name could be delayed for an unspecified time.</para></note>'>
|
|||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||||
<xsdxt:code href="samples/policy_update.json"/>
|
<xsdxt:code href="samples/policy_update.json"/>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
<param name="name" style="plain" required="false">
|
<param name="policy" style="plain" required="true">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||||
<para>New name, if specified, for the target policy.</para>
|
<para>A map that contains the following keys and values that specify
|
||||||
</wadl:doc>
|
the details of the policy to be updated:</para>
|
||||||
</param>
|
<itemizedlist xml:id="policy_update_body">
|
||||||
<param name="spec" style="plain" required="false">
|
<title>Policy body</title>
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
<listitem>
|
||||||
<para>Detailed specification based on the chosen policy type.</para>
|
<para>
|
||||||
</wadl:doc>
|
<code>name</code> New name for the policy, if specified.
|
||||||
</param>
|
</para>
|
||||||
<param name="level" style="plain" required="false">
|
</listitem>
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
<listitem>
|
||||||
<para>A new default enforcement level for the policy.</para>
|
<para>
|
||||||
|
<code>level</code> New enforcement level for the policy, if specified.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<code>cooldown</code> New cooldown seconds for the policy, if specified.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
</wadl:doc>
|
</wadl:doc>
|
||||||
</param>
|
</param>
|
||||||
</representation>
|
</representation>
|
||||||
</request>
|
</request>
|
||||||
<response status="202"/>
|
<response status="200">
|
||||||
|
<representation mediaType="application/json">
|
||||||
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||||
|
<para>A policy record that contains fields like <code>id</code>,
|
||||||
|
<code>name</code>, <code>type</code>, <code>spec</code>, <code>level</code>,
|
||||||
|
<code>cooldown</code>, <code>created_time</code>, <code>updated_time</code>,
|
||||||
|
<code>deleted_time</code> etc.
|
||||||
|
</para>
|
||||||
|
<xsdxt:code href="samples/policy_update_resp.json"/>
|
||||||
|
</wadl:doc>
|
||||||
|
</representation>
|
||||||
|
</response>
|
||||||
</method>
|
</method>
|
||||||
<method name="DELETE" id="policy_delete">
|
<method name="DELETE" id="policy_delete">
|
||||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete policy">
|
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete policy">
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
{
|
{
|
||||||
"spec": {
|
"policy": {
|
||||||
"criteria": "youngest_first",
|
"cooldown": "34",
|
||||||
|
"level": null,
|
||||||
|
"name": null
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"policy": {
|
||||||
|
"cooldown": 34,
|
||||||
|
"created_time": "2015-02-10T12:37:48.000000",
|
||||||
|
"data": {},
|
||||||
|
"deleted_time": null,
|
||||||
|
"id": "714fe676-a08f-4196-b7af-61d52eeded15",
|
||||||
|
"level": 0,
|
||||||
|
"name": "dp01",
|
||||||
|
"spec": {
|
||||||
|
"criteria": "OLDEST_FIRST",
|
||||||
|
"destroy_after_deletion": true,
|
||||||
|
"grace_period": 60,
|
||||||
|
"reduce_desired_capacity": false
|
||||||
|
},
|
||||||
|
"type": "DeletionPolicy",
|
||||||
|
"updated_time": "2015-03-03T05:18:24.000000"
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user