Merge "Add sections describing experimental API"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
2a409c1cbf
@ -20,4 +20,5 @@
|
||||
</annotation>
|
||||
</info>
|
||||
<xi:include href="ch_share-v2.xml"/>
|
||||
<xi:include href="ch_share-v2-experimental.xml"/>
|
||||
</book>
|
||||
|
||||
@ -17,11 +17,11 @@
|
||||
</para>
|
||||
<para>
|
||||
The Shared File Systems API v1 is functionally identical to the <link
|
||||
xlink:type="simple" xlink:href="api-ref-share-v2.html">Shared File
|
||||
Systems API v2.0</link>. Subsequent API v2 micro-versions, such as v2.1,
|
||||
differ from API v1.0.
|
||||
xlink:type="simple" xlink:href="api-ref-share-v2.html">Shared File Systems
|
||||
API v2.0</link>. Subsequent API v2 micro-versions, such as v2.1, differ
|
||||
from API v1.0.
|
||||
</para>
|
||||
<para>
|
||||
Starting with the API v2.0, the API uses Compute-style micro-versions.
|
||||
Starting with API v2.0, the API uses Compute-style micro-versions.
|
||||
</para>
|
||||
</chapter>
|
||||
|
||||
103
api-ref/src/docbkx/ch_share-v2-experimental.xml
Normal file
103
api-ref/src/docbkx/ch_share-v2-experimental.xml
Normal file
@ -0,0 +1,103 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE chapter [
|
||||
<!ENTITY % common_project SYSTEM "../wadls/common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:linkend="http://www.w3.org/1999/linkend"
|
||||
xmlns:xref="http://www.w3.org/1999/xref"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
version="5.0-extension RackBook-2.0"
|
||||
xml:id="share-api-v2-experimental"
|
||||
role="api-reference">
|
||||
<title>Shared File Systems API v2 (EXPERIMENTAL)</title>
|
||||
<para>
|
||||
Contributors can change or remove the experimental part of the Shared
|
||||
File Systems API without maintaining backward compatibility.
|
||||
</para>
|
||||
<section xml:id="consistency-groups">
|
||||
<title>Consistency groups (since API v2.4)</title>
|
||||
<para>
|
||||
Consistency groups enable you to create snapshots at the exact
|
||||
same point in time from multiple file system shares. For example,
|
||||
a database might place its tables, logs, and configuration on
|
||||
separate shares. To restore this database from a previous point
|
||||
in time, it makes sense to restore the logs, tables, and
|
||||
configuration together from the exact same point in time.
|
||||
</para>
|
||||
<para>
|
||||
As an administrator, you can also reset the state of a consistency
|
||||
group and force-delete a specified consistency group in any state.
|
||||
Use the <code>policy.json</code> file to grant permissions for
|
||||
these actions to other roles.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#consistency-groups">
|
||||
<wadl:method href="#createConsistencyGroup"/>
|
||||
<wadl:method href="#getConsistencyGroups"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#detail-consistency-groups">
|
||||
<wadl:method href="#getConsistencyGroupsDetails"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#consistency_group_id">
|
||||
<wadl:method href="#getConsistencyGroup"/>
|
||||
<wadl:method href="#updateConsistencyGroup"/>
|
||||
<wadl:method href="#deleteConsistencyGroup"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#consistency-groups-action">
|
||||
<wadl:method href="#resetConsistencyGroupState"/>
|
||||
<wadl:method href="#force-deleteConsistencyGroup"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="consistency-group-snapshots">
|
||||
<title>Consistency group snapshots (since API v2.4)</title>
|
||||
<para>
|
||||
You can create snapshots of consistency groups. To create a
|
||||
snapshot, you specify the ID of the consistency group that you
|
||||
want to snapshot. After you create a consistency group snapshot,
|
||||
you can create a consistency group from it.
|
||||
</para>
|
||||
<para>
|
||||
A consistency group snapshot can have member shares. To add a
|
||||
member share, include the <code>consistency_group_id</code>
|
||||
parameter in the create share request. This ID must match the ID
|
||||
of the consistency group from which the consistency group snapshot
|
||||
was created. Then, when you use consistency group snapshots to
|
||||
restore data, you can easily determine which shares belong to a
|
||||
specified consistency group.
|
||||
</para>
|
||||
<para>
|
||||
As an administrator, you can also reset the state of a consistency
|
||||
group snapshot and force-delete a specified consistency group
|
||||
snapshot in any state. Use the <code>policy.json</code> file to
|
||||
grant permissions for these actions to other roles.
|
||||
</para>
|
||||
<para></para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshots">
|
||||
<wadl:method href="#createConsistencyGroupSnapshot"/>
|
||||
<wadl:method href="#getConsistencyGroupSnapshots"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#detail-cgsnapshots">
|
||||
<wadl:method href="#getConsistencyGroupSnapshotsDetails"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshot_id">
|
||||
<wadl:method href="#getConsistencyGroupSnapshot"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshot-members">
|
||||
<wadl:method href="#getConsistencyGroupSnapshotMembers"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshot_id">
|
||||
<wadl:method href="#updateConsistencyGroupSnapshot"/>
|
||||
<wadl:method href="#deleteConsistencyGroupSnapshot"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshots-action">
|
||||
<wadl:method href="#resetConsistencyGroupSnapshotState"/>
|
||||
<wadl:method href="#force-deleteConsistencyGroupSnapshot"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
@ -59,8 +59,8 @@
|
||||
<title>Limits</title>
|
||||
<para>
|
||||
Limits are the resource limitations that are allowed for each
|
||||
tenant (project). An administrator can configure limits in
|
||||
the <code>manila.conf</code> file.
|
||||
tenant (project). An administrator can configure limits in the
|
||||
<code>manila.conf</code> file.
|
||||
</para>
|
||||
<para>
|
||||
Users can query their rate and absolute limits. The absolute
|
||||
|
||||
528
api-ref/src/wadls/share-api/src/v2/experimental.ent
Normal file
528
api-ref/src/wadls/share-api/src/v2/experimental.ent
Normal file
@ -0,0 +1,528 @@
|
||||
<!ENTITY createConsistencyGroupRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_types" style="plain" required="false"
|
||||
type="xsd:list">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A list of one or more share type IDs.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_network_id" style="plain" required="false"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of a share network.
|
||||
</para>
|
||||
<para>
|
||||
Note that when using a share type with the
|
||||
<code>driver_handles_share_servers</code> extra spec as
|
||||
<code>False</code>, you should not provide a
|
||||
<code>share_network_id</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="source_cgsnapshot_id" style="plain" required="false"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the consistency group snapshot from which to create the
|
||||
consistency group.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY createConsistencyGroupResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group status. A valid value is
|
||||
<code>creating</code>, <code>available</code>, <code>error</code>,
|
||||
<code>deleting</code>, or <code>error_deleting</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="source_cgsnapshot_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot ID. A valid value is <code>null</code> or
|
||||
the ID of the consistency group snapshot, if the consistency group was
|
||||
created from a snapshot.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="created_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the consistency group was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_network_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of a share network.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group host name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="project_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the project in which the consistency group was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_types" style="plain" required="true"
|
||||
type="xsd:list">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A list of share type IDs.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY getConsistencyGroupsResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY updateConsistencyGroupRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY resetConsistencyGroupStateRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group status. A valid value is <code>creating</code>,
|
||||
<code>error</code>, <code>available</code>, <code>deleting</code>, or
|
||||
<code>error_deleting</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY force-deleteConsistencyGroupRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="os-force_delete" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
To force-delete a consistency group, set this value to <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY createConsistencyGroupSnapshotRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="consistency_group_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the consistency group from which to create a snapshot.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY createConsistencyGroupSnapshotResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot status, which is
|
||||
<code>available</code>, <code>creating</code>, <code>error</code>,
|
||||
<code>deleting</code>, or <code>error_deleting</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="project_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the project in which the consistency group snapshot was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="consistency_group_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the consistency group from which the snapshot was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="created_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the consistency group snapshot was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY getConsistencyGroupSnapshotsResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY getConsistencyGroupSnapshotMembersResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot member ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the share that is a consistency group snapshot member.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_type_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The share type ID of the member.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="created_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the member was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="cgsnapshot_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_protocol" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The file system protocol of the member, which is <code>NFS</code>,
|
||||
<code>CIFS</code>, <code>GlusterFS</code>, or <code>HDFS</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="project_id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the project in which the consistency group snapshot member was
|
||||
created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="size" style="plain" required="true"
|
||||
type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The member size, in GBs.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY updateConsistencyGroupSnapshotRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="name" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="description" style="plain" required="false"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot description.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY resetConsistencyGroupSnapshotStateRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="status" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The consistency group snapshot status. A valid value is
|
||||
<code>creating</code>, <code>error</code>, <code>available</code>,
|
||||
<code>deleting</code>, or <code>error_deleting</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY force-deleteConsistencyGroupSnapshotRequestParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="os-force_delete" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
To force-delete a consistency group snapshot, set this value to
|
||||
<code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
392
api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl
Normal file
392
api-ref/src/wadls/share-api/src/v2/os-share-v2-experimental.wadl
Normal file
@ -0,0 +1,392 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2015 OpenStack Foundation, All Rights Reserved -->
|
||||
<!DOCTYPE application[
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
%common;
|
||||
<!ENTITY % experimental SYSTEM "experimental.ent">
|
||||
%experimental;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:common="http://docs.openstack.org/common/api/v1.0"
|
||||
xmlns:csapi="http://docs.openstack.org/share/api/v1.0"
|
||||
xmlns:db="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0">
|
||||
<resources base="https://share_server_id.example.com/" xml:id="os-share-v1.0">
|
||||
<resource id="versions" path="/">
|
||||
<param name="X-Openstack-Manila-Api-Version" style="header" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>A valid Shared File Systems API micro-version.
|
||||
For example,
|
||||
<code>"X-Openstack-Manila-Api-Version: 2.6"</code>.
|
||||
If you omit this header, the default micro-version is 2.0.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#share-listVersions" />
|
||||
<resource id="version" path="v2">
|
||||
<resource id="extensions" path="extensions">
|
||||
<method href="#getExtensions" />
|
||||
</resource>
|
||||
<resource id="tenant_id" path="{tenant_id}">
|
||||
<param name="X-OpenStack-Manila-API-Experimental" style="header" type="xsd:bool"
|
||||
required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Indicates that this is an experimental Shared File
|
||||
Systems API request. Set to <code>true</code>.
|
||||
For example,
|
||||
<code>"X-OpenStack-Manila-API-Experimental: true"</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="tenant_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The tenant ID in a multi-tenancy cloud.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="consistency-groups" path="consistency-groups">
|
||||
<method href="#createConsistencyGroup" />
|
||||
<method href="#getConsistencyGroups" />
|
||||
<resource path="detail" id="detail-consistency-groups">
|
||||
<method href="#getConsistencyGroupsDetails" />
|
||||
</resource>
|
||||
<resource path="{consistency_group_id}" id="consistency_group_id">
|
||||
<param name="consistency_group_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The unique identifier of the consistency group.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getConsistencyGroup" />
|
||||
<method href="#updateConsistencyGroup" />
|
||||
<method href="#deleteConsistencyGroup" />
|
||||
<resource id="consistency-groups-action" path="action">
|
||||
<method href="#resetConsistencyGroupState" />
|
||||
<method href="#force-deleteConsistencyGroup" />
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="cgsnapshots" path="cgsnapshots">
|
||||
<method href="#createConsistencyGroupSnapshot" />
|
||||
<method href="#getConsistencyGroupSnapshots" />
|
||||
<resource path="detail" id="detail-cgsnapshots">
|
||||
<method href="#getConsistencyGroupSnapshotsDetails" />
|
||||
</resource>
|
||||
<resource path="{cgsnapshot_id}" id="cgsnapshot_id">
|
||||
<param name="cgsnapshot_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The unique identifier of the consistency group snapshot.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource path="members" id="cgsnapshot-members">
|
||||
<method href="#getConsistencyGroupSnapshotMembers" />
|
||||
</resource>
|
||||
<method href="#getConsistencyGroupSnapshot" />
|
||||
<method href="#updateConsistencyGroupSnapshot" />
|
||||
<method href="#deleteConsistencyGroupSnapshot" />
|
||||
<resource id="cgsnapshots-action" path="action">
|
||||
<method href="#resetConsistencyGroupSnapshotState" />
|
||||
<method href="#force-deleteConsistencyGroupSnapshot" />
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resources>
|
||||
<method name="POST" id="createConsistencyGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Create consistency group">
|
||||
<para role="shortdesc">Creates a consistency group.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-create-request.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-create-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroups">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List consistency groups">
|
||||
<para role="shortdesc">Lists all consistency groups.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-list-response.json" />
|
||||
</wadl:doc>
|
||||
&getConsistencyGroupsResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroupsDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="List consistency groups with details">
|
||||
<para role="shortdesc">Lists all consistency groups with details.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-list-detailed-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Show consistency group">
|
||||
<para role="shortdesc">Shows information about a specified consistency group.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-show-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="updateConsistencyGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Update consistency group">
|
||||
<para role="shortdesc">Updates a specified consistency group.</para>
|
||||
<para>You can update only these attributes:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>name</code>, which changes the consistency group name.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>description</code>, which changes the consistency group description.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-update-request.json" />
|
||||
</wadl:doc>
|
||||
&updateConsistencyGroupRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-update-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteConsistencyGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Delete consistency group">
|
||||
<para role="shortdesc">Deletes a specified consistency group.</para>
|
||||
</wadl:doc>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="POST" id="resetConsistencyGroupState">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Reset consistency group state">
|
||||
<para role="shortdesc">Administrator only. Explicitly updates the state of a specified consistency group.</para>
|
||||
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-reset-state-request.json" />
|
||||
</wadl:doc>
|
||||
&resetConsistencyGroupStateRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="POST" id="force-deleteConsistencyGroup">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Force-delete consistency group">
|
||||
<para role="shortdesc">Administrator only. Force-deletes a specified consistency group.</para>
|
||||
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-consistency-group-force-delete-request.json" />
|
||||
</wadl:doc>
|
||||
&force-deleteConsistencyGroupRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="POST" id="createConsistencyGroupSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Create consistency group snapshot">
|
||||
<para role="shortdesc">Creates a consistency group snapshot.</para>
|
||||
<para>
|
||||
You can create a consistency group snapshot for a consistency group
|
||||
in <code>available</code> state only.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-create-request.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupSnapshotRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-create-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupSnapshotResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroupSnapshots">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="List consistency group snapshots">
|
||||
<para role="shortdesc">Lists all consistency group snapshots.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-list-response.json" />
|
||||
</wadl:doc>
|
||||
&getConsistencyGroupSnapshotsResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroupSnapshotsDetails">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="List consistency group snapshots with details">
|
||||
<para role="shortdesc">Lists all consistency group snapshots with details.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-list-detailed-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupSnapshotResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroupSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Show consistency group snapshot">
|
||||
<para role="shortdesc">Shows information about a specified consistency group snapshot.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-show-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupSnapshotResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getConsistencyGroupSnapshotMembers">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Show consistency group snapshot member">
|
||||
<para role="shortdesc">Shows information about a specified consistency group snapshot member.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-list-members-response.json" />
|
||||
</wadl:doc>
|
||||
&getConsistencyGroupSnapshotMembersResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="updateConsistencyGroupSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Update consistency group snapshot">
|
||||
<para role="shortdesc">Updates a specified consistency group snapshot.</para>
|
||||
<para>You can update only these attributes:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>name</code>, which changes the consistency group snapshot name.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>description</code>, which changes the consistency group snapshot description.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-update-request.json" />
|
||||
</wadl:doc>
|
||||
&updateConsistencyGroupSnapshotRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-update-response.json" />
|
||||
</wadl:doc>
|
||||
&createConsistencyGroupSnapshotResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteConsistencyGroupSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Delete consistency group snapshot">
|
||||
<para role="shortdesc">Deletes a specified consistency group snapshot.</para>
|
||||
</wadl:doc>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="POST" id="resetConsistencyGroupSnapshotState">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Reset consistency group snapshot state">
|
||||
<para role="shortdesc">Administrator only. Explicitly updates the state of a specified consistency group snapshot.</para>
|
||||
<para>Administrators can use the <code>policy.json</code> file to permit other roles to complete this action.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-reset-state-request.json" />
|
||||
</wadl:doc>
|
||||
&resetConsistencyGroupSnapshotStateRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="POST" id="force-deleteConsistencyGroupSnapshot">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Force-delete consistency group snapshot">
|
||||
<para role="shortdesc">Administrator only. Force-deletes a specified consistency group snapshot.</para>
|
||||
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-cg-snapshot-force-delete-request.json" />
|
||||
</wadl:doc>
|
||||
&force-deleteConsistencyGroupSnapshotRequestParameter;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202" />
|
||||
</method>
|
||||
</application>
|
||||
Loading…
Reference in New Issue
Block a user