diff --git a/api-ref/src/docbkx/ch_blockstorage-api-v1.xml b/api-ref/src/docbkx/ch_blockstorage-api-v1.xml index 29765c00a..6b069f538 100644 --- a/api-ref/src/docbkx/ch_blockstorage-api-v1.xml +++ b/api-ref/src/docbkx/ch_blockstorage-api-v1.xml @@ -35,38 +35,33 @@
API versions + + Lists information about API versions. + - + - - - +
Volumes - The snapshot_id and source_volid - parameters specify the ID of the snapshot or volume from which - the volume originates. - If the volume was not created from a snapshot or source volume, - these values are null. + The snapshot_id and source_volid + parameters specify the ID of the snapshot or volume from which the + volume originates. If the volume was not created from a snapshot or + source volume, these values are null. - + - + - + @@ -74,14 +69,15 @@
Volume types + + Lists, creates, updates, shows information for, and deletes volume types. + - + - + @@ -91,23 +87,23 @@
Snapshots + + Creates, lists, shows information for, and deletes snapshots. + Shows and updates snapshot metadata. + - + - + - + - + @@ -115,28 +111,13 @@
Quota sets extension (os-quota-sets) - Administrators only, depending on policy settings. + + Administrators only, depending on policy settings. Shows, updates, and deletes quotas for a tenant. - - - - - - - - - - - - - - - - - - +
diff --git a/api-ref/src/wadls/common_project.ent b/api-ref/src/wadls/common_project.ent index 61dfd44c3..0773461f3 100644 --- a/api-ref/src/wadls/common_project.ent +++ b/api-ref/src/wadls/common_project.ent @@ -336,31 +336,6 @@ '> - - - - The date and time when the resource was created. - - - The date and time stamp format is ISO 8601: - - CCYY-MM-DDThh:mm:ss±hh:mm - - For example, 2015-08-27T09:49:58-05:00. - - - The ±hh:mm value, if included, is the time zone as an - offset from UTC. In the previous example, the offset value is - -05:00. - - -'> - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + '> - - + + '> - + + + '> + - The UUID of the backup. + The UUID for a backup. '> + @@ -75,21 +77,19 @@ '> + - + The ID of the consistency group. '> + @@ -99,14 +99,13 @@ '> + - The UUID of the interface. + The interface ID. '> @@ -123,9 +122,8 @@ '> + @@ -135,9 +133,8 @@ '> + @@ -147,45 +144,54 @@ '> + The UUID of the tenant in a multi-tenancy cloud. - + '> - + - The UUID of the tenant for which you want to show, update, or delete + The UUID of the administrative tenant. + + +'> + + + + The UUID for the tenant for which you want to show, update, or delete quotas. This UUID is different from the first tenant ID that you specify in the URI: That UUID is for the administrative tenant. '> + - + The user ID. Specify in the URI as user_id={user_id}. '> + @@ -195,466 +201,28 @@ '> + - The UUID of the volume type. + The UUID for an existing volume type. '> - - - - The UUID for an existing volume type. - - -'> - - - - Sorts the response by an attribute. Default is created_at. The API uses - the natural sorting direction of the attribute that is provided as the - sort_key. - - -'> - - - - Sorts the response by one or more sets of attribute and sort direction - combinations. If you omit the sort direction in a set, the default is - desc. - - -'> - - - - Set to usage=True to show quota usage. Default is - False. - -'> - - - A quota_set object. - - - - The number of instance cores allowed for - each tenant. - - - + + + + + - The number of fixed IP addresses allowed for each tenant. Must be - equal to or greater than the number of allowed instances. - - - - - - The number of floating IP addresses allowed for each tenant. - - - - - The ID for the quota set. - - - - - The number of bytes of content allowed for each injected file. - - - - - The number of bytes allowed for each - injected file path. - - - - The number of injected files allowed for - each tenant. - - - - The number of instances allowed for each - tenant. - - - - The number of key pairs allowed for each - user. - - - - The number of metadata items allowed for - each instance. - - - - The amount of instance RAM in megabytes - allowed for each tenant. - - - - The number of rules allowed for each - security group. - - - - The number of security groups allowed - for each tenant. -'> - - - - The in use data size. Visible only if you set the - usage=True query parameter. - - - - - - - Reserved volume size. Visible only if you set the - usage=True query parameter. - - -'> - - - A quota_set object. - - - - The number of instance cores allowed for - each tenant. - - - - - The number of fixed IP addresses allowed for each tenant. Must be - equal to or greater than the number of allowed instances. - - - - - The number of floating IP addresses - allowed for each tenant. - - - - The ID for the quota set. - - - - The number of bytes of content allowed - for each injected file. - - - - The number of bytes allowed for each - injected file path. - - - - The number of injected files allowed for - each tenant. - - - - The number of instances allowed for each - tenant. - - - - The number of key pairs allowed for each - user. - - - - - The number of metadata items allowed for each instance. - - - - - The amount of instance RAM in megabytes - allowed for each tenant. - - - - The number of rules allowed for each - security group. - - - - - The number of security groups allowed for each tenant. - -'> - - - A limits object. - - - - An absolute limits object. - - - - Total number of snapshots used. - - - - Maximum number of backups. - - - - Maximum total amount of volumes, in gibibytes (GiB). - - - - Maximum number of snapshots. - - - - Maximum total amount of backups, in gibibytes (GiB). - - - - Total number of backups gibibytes (GiB) used. - - - - Maximum number of volumes. - - - - Total number of volumes used. - - - - Total number of backups used. - - - - Total number of gibibytes (GiB) used. -'> - - - The availability zone. - - - - - Sorts by an attribute. A valid value is name, - status, container_format, - disk_format, size, id, - created_at, or updated_at. Default is - created_at. The API uses the natural sorting direction of - the sort_key attribute value. + Comma-separated list of sort keys and optional sort directions in the + form of <key>[:<direction>]. A valid direction is + asc (ascending) or desc (descending). '> @@ -669,9 +237,24 @@ '> + + + + Sorts by an attribute. A valid value is name, + status, container_format, + disk_format, size, id, + created_at, or updated_at. Default is + created_at. The API uses the natural sorting direction of + the sort_key attribute value. + + +'> '> - - + + + + @@ -695,22 +280,32 @@ '> - + - A limits object. + The connector object. '> - + + + + A list of limit objects. + + +'> + @@ -719,10 +314,10 @@ '> - + @@ -731,7 +326,7 @@ '> - @@ -743,124 +338,578 @@ '> - - A list of snapshot objects. + A list of snapshot objects. '> - - + + A volume object. '> - + name="volumes" style="plain" type="xsd:list" required="true"> - A list of volume objects. + A list of volume objects. '> - - + - A volume type object. + A volume_type object. '> - + + + A list of volume_type objects. + + +'> + + + + - A list of volume types. + The total number of snapshots used. + + + + - In an environment with multiple-storage back ends, the scheduler - determines where to send the volume based on the volume type. + The maximum number of backups. + + + + - For information about how to use volume types to create multiple-storage - back ends, see Configure - multiple-storage back ends. + The maximum total amount of volumes, in gibibytes (GiB). + + + + + + + The maximum number of snapshots. + + + + + + + The maximum total amount of backups, in gibibytes (GiB). + + + + + + + The total number of backups gibibytes (GiB) used. + + + + + + + The maximum number of volumes. + + + + + + + The total number of volumes used. + + + + + + + The total number of backups used. + + + + + + + The total number of gibibytes (GiB) used. '> - + + + + + - - - - +"a_setObjectParameter; + - The UUID of attachment. + The number of instance cores that are allowed for each tenant. + + + + + + + The number of fixed IP addresses that are allowed for each tenant. Must + be equal to or greater than the number of allowed instances. + + + + + + + The number of floating IP addresses that are allowed for each tenant. + + + + + + + The ID for the quota set. + + + + + + + The number of bytes of content that are allowed for each injected file. + + + + + + + The number of bytes that are allowed for each injected file path. + + + + + + + The number of injected files that are allowed for each tenant. + + + + + + + The number of instances that are allowed for each tenant. + + + + + + + The number of key pairs that are allowed for each user. + + + + + + + The number of metadata items that are allowed for each instance. + + + + + + + The amount of instance RAM in megabytes that are allowed for each tenant. + + + + + + + The number of rules that are allowed for each security group. + + + + + + + The number of security groups that are allowed for each tenant. '> - + + + + + + The number of instance cores that are allowed for each tenant. + + + + + + + The number of fixed IP addresses that are allowed for each tenant. Must + be equal to or greater than the number of allowed instances. + + + + + + + The number of floating IP addresses that are allowed for each tenant. + + + + + + + The ID for the quota set. + + + + + + + The number of bytes of content that are allowed for each injected file. + + + + + + + The number of bytes that are allowed for each injected file path. + + + + + + + The number of injected files that are allowed for each tenant. + + + + + + + The number of instances that are allowed for each tenant. + + + + + + + The number of key pairs that are allowed for each user. + + + + + + + The number of metadata items that are allowed for each instance. + + + + + + + The amount of instance RAM in megabytes that are allowed for each + tenant. + + + + + + + The number of rules that are allowed for each security group. + + + + + + + The number of security groups that are allowed for each tenant. + + + + + + + The in use data size. Visible only if you set the + usage=True query parameter. + + + + + + + Reserved volume size. Visible only if you set the + usage=True query parameter. + + +'> + + + + The volume name. + + + + + + + The UUID of the volume. + + + + + + + The volume links. + + +'> + + + + The volume status. + + + + + + + The volume name. + + + + + + + Instance attachment information. + + + If this volume is attached to a server instance, the attachments list + includes the UUID of the attached server, an attachment UUID, the name + of the attached host, if any, the volume UUID, the device, and the + device UUID. + + + Otherwise, this list is empty. + + + + type="xsd:string" required="true"> @@ -868,35 +917,10 @@ The availability zone. -'> - - - - The connector object. - - -'> - - - - The number of instance cores allowed for each tenant. - - -'> - + +&created_at-ResponseParameter; + @@ -904,245 +928,288 @@ The volume description. -'> - + name="volume_type" style="plain" + type="xsd:string" required="true"> - A key and value pair that contains additional specifications for the - volume type. Examples include capabilities, capacity, compression, and - so on, depending on the storage driver in use. + The volume type. In an environment with multiple-storage back ends, the + scheduler determines where to send the volume based on the volume + type. + + + For information about how to use volume types to create multiple- + storage back ends, see Configure + multiple-storage back ends. -'> - + + - The number of fixed IP addresses allowed for each tenant. Must be - equal to or greater than the number of allowed instances. + The UUID of the source volume snapshot. -'> - + name="source_volid" style="plain" + type="csapi:UUID" required="true"> - The number of floating IP addresses allowed for each tenant. + The UUID of the source volume. -'> - + + - The name of the attaching host. - - -'> - - - - The UUID of the image from which you want to create a bootable volume. - - -'> - - - - The number of bytes of content allowed for each injected file. - - -'> - - - - The number of bytes allowed for each injected file path. - - -'> - - - - The number of injected files allowed for each tenant. - - -'> - - - - The UUID of the attaching instance. - - -'> - - - - The number of instances allowed for each tenant. - - -'> - - - - The volume type access. - - - Set to true if access is public. Set to false - if access is private. Default is true. - - -'> - - - - The number of key pairs allowed for each user. - - -'> - - - - One or more metadata key and value pairs to associate with the + One or more metadata key and value pairs that are associated with the volume. -'> - + + + + The UUID of the volume. + + + + + + + The size of the volume, in gibibytes (GiB). + + + + name="os-volume-replication:driver_data" style="plain" type="xsd:string" + required="false"> + + + The name of the volume replication driver. + + + + + + + The status of the volume replication. + + +'> + + xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> - One or more metadata key and value pairs to set or unset for the - snapshot. - - - To unset a metadata key value, specify only the key name. - - - To set a metadata key value, specify the key and value pair. - - - The Block Storage server does not respect case-sensitive key - names. For example, if you specify both "key": "v1" and - "KEY": "V1", the server sets and returns only the - KEY key and value pair. + The volume status. -'> - - - - The number of metadata items allowed for each instance. - - -'> - - - - The attaching mount point. - - -'> - - - - To enable this volume to attach to more than one server, set this - value to true. Default is false. - - -'> - - + name="name" style="plain" type="xsd:string" required="true"> + The volume name. -'> - + + + Instance attachment information. + + + If this volume is attached to a server instance, the attachments list + includes the UUID of the attached server, an attachment UUID, the name + of the attached host, if any, the volume UUID, the device, and the + device UUID. + + + Otherwise, this list is empty. + + + + + + + The availability zone. + + + +&created_at-ResponseParameter; + + + + The volume description. + + + + + + + The associated volume type. + + + + + + + The UUID of the source volume snapshot. + + + + + + + The UUID of the source volume. + + + + + + + One or more metadata key and value pairs that are associated with the + volume. + + + + + + + The UUID of the volume. + + + + + + + The size of the volume, in gibibytes (GiB). + + + + + + + The name of the volume replication driver. + + + + + + + The status of the volume replication. + + +'> + + + + The number of gigabytes that are allowed for each tenant. + + + + + + + The number of snapshots that are allowed for each tenant. + + + + + + + The number of volumes that are allowed for each tenant. + + +'> + '> '> + + + + The action. + + + + + + + The UUID of the attaching instance. + + + + + + + The name of the attaching host. + + + + + + + The attaching mount point. + + +'> -'> - - - - The action. - - -'> - - - - A quota_set object. - - -'> - - - - The ID of the quota set. - - -'> - - - - The amount of instance RAM, in megabytes, allowed for each tenant. - - -'> - - - - Reserved volume size. Visible only if you set the - usage=True query parameter. - - -'> - - - - The number of rules allowed for each security group. - - -'> - - - - The number of security groups allowed for each tenant. - - -'> - - - - The size of the volume, in gibibytes (GiB). - - -'> - - - - To create a volume from an existing snapshot, specify the UUID of the - volume snapshot. The API creates the volume in same availability zone - and with same size as the snapshot. - - -'> - - - - To create a volume from an existing volume, specify the UUID of the - volume. The API creates the volume with the same size as the source - volume. - - -'> - - - - The volume type. To create an environment with multiple-storage back ends, - you must specify a volume type. Block Storage volume back ends are spawned - as children to cinder-volume, and they are keyed from a - unique queue. They are named cinder-volume.HOST.BACKEND. For - example, cinder-volume.ubuntu.lvmdriver. When a volume is - created, the scheduler chooses an appropriate back end to handle the - request based on the volume type. - - - Default is None. - - - For information about how to use volume types to create - multiple-storage back ends, see Configure - multiple-storage back ends. - - -'> - - - - - Instance attachment information. - - - If this volume is attached to a server instance, the attachments list - includes the UUID of the attached server, an attachment UUID, the name - of the attached host, if any, the volume UUID, the device, and the - device UUID. - - - Otherwise, this list is empty. - - -'> - - - - The availability zone. - - -'> - - - - If set to true, the volume is bootable. - - -'> - - - - The number of instance cores allowed for each tenant. - - -'> - - - - The volume description. - - -'> - - - - The number of fixed IP addresses allowed for each tenant. Must be - equal to or greater than the number of allowed instances. - - -'> - - - - The number of floating IP addresses allowed for each tenant. - - -'> - - - - The number of gigabytes allowed for each tenant. - - -'> - - - - The UUID of the volume. - - -'> - - - - The UUID of the source image, if any. - - -'> - - - - The number of bytes of content allowed for each injected file. - - -'> - - - - The number of bytes allowed for each injected file path. - - -'> - - - - The number of injected files allowed for - each tenant. - - -'> - - - - The number of instances allowed for each - tenant. - - -'> - - - - The in use data size. Visible only if you set the - usage=True query parameter. - - -'> - - - - The volume type access. - - - Set to true if access is public. Set to false - if access is private. - - -'> - - - - The number of key pairs allowed for each - user. - - -'> - - - - The volume links. - - -'> - - - - Maximum number of backups. - - -'> - - - - Maximum total amount of backups, in gibibytes (GiB). - - -'> - - - - Maximum number of snapshots. - - -'> - - - - Maximum number of volumes. - - -'> - - - - Maximum total amount of volumes, in gibibytes (GiB). - - -'> - - - - One or more metadata key and value pairs for the - volume. - - -'> - - - - The number of metadata items allowed for each instance. - - -'> - - - - If true, this volume can attach to more than one instance. - - -'> - - - - The volume name. - - -'> - - - - The volume host attribute. - - -'> - - - - The tenant ID. - - -'> - - - - The name of the volume replication driver. - - -'> - - - - The status of the volume replication. - - -'> - - - - The ID of the quota set. - - -'> - - - - The amount of instance RAM in megabytes allowed for each tenant. - - -'> - - - - The number of rules allowed for each security group. - - -'> - - - - The number of security groups allowed for each tenant. - - -'> - - - - The size of the volume, in gibibytes (GiB). - - -'> - - - - The number of snapshots allowed for each tenant. - - -'> - - - - The UUID of the source snapshot, if any. - - -'> - - - - The UUID of the source volume, if any. - - -'> - - - - The volume status. - - -'> - - - - Total number of backups gibibytes (GiB) used. - - -'> - - - - Total number of backups used. - - -'> - - - - Total number of gibibytes (GiB) used. - - -'> - - - - Total number of snapshots used. - - -'> - - - - Total number of volumes used. - - -'> - - - - The volume type. In an environment with multiple-storage back ends, the - scheduler determines where to send the volume based on the volume - type. - - - For information about how to use volume types to create multiple-storage - back ends, see Configure - multiple-storage back ends. - - -'> - - - - The number of volumes allowed for each tenant. - - '> - - - - - - The storage name space, such as + The storage namespace, such as OS::Storage::Capabilities::foo. @@ -2226,7 +1537,7 @@ - + The driver version. @@ -2237,7 +1548,7 @@ - + The storage protocol, such as Fibre Channel, iSCSI, NFS, and so on. @@ -2248,7 +1559,7 @@ - + The display name. @@ -2259,7 +1570,7 @@ - + The storage description. @@ -2271,8 +1582,8 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - Enables public or private visibility. Set to True to make - the back end publicly visible. + Enables public or private visibility. Set to True to + make the back end publicly visible. @@ -2282,12 +1593,12 @@ - + A set of storage properties, such as QoS, IOPS, and so on. '> - @@ -2310,7 +1621,181 @@ '> - + + + + + + + + The name of the consistency group. + + + + + + + The description of the consistency group. + + + + + + + The list of volume types. + + + In an environment with multiple-storage back ends, the scheduler + determines where to send the volume based on the volume type. + + + For information about how to use volume types to create multiple-storage + back ends, see Configure + multiple-storage back ends. + + + + + + + The UUID of the user. + + + + + + + The UUID of the project. + + + + + + + The name of the availability zone. + + + + + + + The status of the consistency group. + + +'> + + + + The name of the consistency group. + + + + + + + The description of the consistency group. + + + + + + + The UUID of the consistency group snapshot. + + + + + + + The UUID of the source consistency group. + + + + + + + The UUID of the user. + + + + + + + The UUID of the project. + + + + + + + The status of the consistency group. + + +'> + + + + @@ -2332,11 +1817,21 @@ The consistency group status. A valid value is creating, available, error, deleting, updating, or invalid. + + + + + + + The availability zone name. -&availability_zoneResponseParameter; -&created_atResponseParameter; +&created_at-ResponseParameter; @@ -2359,142 +1854,8 @@ '> - - - - The name of the consistency group. - - - - - - - The description of the consistency group. - - - -&volume_typesObject; - - - - The UUID of the user. - - - - - - - The UUID of the project. - - - -&availability_zoneRequestParameter; - - - - The status of the consistency group. - - -'> - - - - The name of the consistency group. - - - - - - - The description of the consistency group. - - - - - - - The UUID of the consistency group snapshot. - - - - - - - The UUID of the source consistency group. - - - - - - - The UUID of the user. - - - - - - - The UUID of the project. - - - - - - - The status of the consistency group. - - -'> + + - If set to true, forces deletion of a consistency group that - has a registered volume. + If set to true, forces deletion of a consistency group + that has a registered volume. '> - @@ -2521,15 +1882,15 @@ - - - The consistency group description. - - + + The consistency group description. + + - One or more volume UUIDs to add to the volume consistency group. - Use a comma to separate values. + One or more volume UUIDs, separated by commas, to add to the volume + consistency group. - - - One or more volume UUIDs to remove from the volume consistency group. - Use a comma to separate values. - - + + One or more volume UUIDs, separated by commas, to remove from the + volume consistency group. + + '> - - - + + The UUID of the consistency group snapshot. - - + + - - - The consistency group snapshot name. - - -'> - - - - The UUID of the consistency group snapshot. - - - - - - - The UUID of the consistency group. - - - - - - - The status of the consistency group snapshot. - - - -&created_atResponseParameter; - - - - The consistency group snapshot name. - - - - - - - The consistency group snapshot description. - - + + + The consistency group snapshot name. + + '> + + + The consistency group snapshot name. + + +'> + - - + + + The UUID of the consistency group snapshot. + + + + + + The UUID of the consistency group. - - + + - - - The consistency group snapshot name. - - - - - - - The consistency group snapshot description. - - - - - - - The UUID of the user. - - - - - - - The UUID of the project. - - - - - - + + The status of the consistency group snapshot. - - + + + +&created_at-ResponseParameter; + + + + The consistency group snapshot name. + + + + + + + The consistency group snapshot description. + + +'> + + + + The UUID of the consistency group. + + + + + + + The consistency group snapshot name. + + + + + + + The consistency group snapshot description. + + + + + + + The UUID of the user. + + + + + + + The UUID of the project. + + + + + + + The status of the consistency group snapshot. + + '> - The status of the snapshot. + The status for the snapshot. @@ -2719,12 +2092,13 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - A description of the snapshot. + A description for the snapshot. -&created_atResponseParameter; - - - If the snapshot was created from a volume, the UUID of the volume. + If the snapshot was created from a volume, the volume ID. @@ -2761,7 +2135,7 @@ xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"> - The UUID of the snapshot. + The snapshot UUID. @@ -2775,47 +2149,11 @@ '> - - - - A set of key and value pairs that contains the properties for a volume - type. - - - - - - - The name of the volume type. - - - - - - - A set of key and value pairs that contains the specifications for a - volume type. - - -'> - - @@ -2827,14 +2165,556 @@ + + + The UUID for the volume type. + + + + + + + The name of the volume type. + + + + - The UUID of the volume type. + A set of key and value pairs that contains the specifications for a + volume type. + + +'> + + + + + + + + + One or more metadata key and value pairs for the snapshot. + + +'> + + + + + + + + + The size of the volume, in gibibytes (GiB). + + + + The availability zone. + + + + + + + The UUID of the source volume. The API creates a new volume with the + same size as the source volume. + + + + + + + The volume description. + + + + + + + To enable this volume to attach to more than one server, set this + value to true. Default is false. + + + + + + + To create a volume from an existing snapshot, specify the UUID of the + volume snapshot. The volume is created in same availability zone and + with same size as the snapshot. + + + + + + + The volume name. + + + + + + + The UUID of the image from which you want to create the volume. Required + to create a bootable volume. + + + + + + + The volume type. To create an environment with multiple-storage back + ends, you must specify a volume type. Block Storage volume back ends are + spawned as children to cinder-volume, and they are keyed + from a unique queue. They are named cinder- + volume.HOST.BACKEND. For example, cinder- + volume.ubuntu.lvmdriver. When a volume is created, the scheduler + chooses an appropriate back end to handle the request based on the + volume type. + + + Default is None. + + + For information about how to use volume types to create multiple-storage + back ends, see Configure + multiple-storage back ends. + + + + + + + One or more metadata key and value pairs that are associated with the + volume. + + + + + + + The UUID of the primary volume to clone. + + + + + + + The UUID of the consistency group. + + +'> + + + + + + + The availability zone. + + + + + + + The UUID of the source volume, if any. + + + + + + + The volume description. + + + + + + + If true, this volume can attach to more than one instance. + + + + + + + The UUID of the source snapshot, if any. + + + + + + + The size of the volume, in gibibytes (GiB). + + + + + + + The volume name. + + + + + + + The UUID of the source image, if any. + + + + + + + The associated volume type. + + + + + + + Metadata key and value pairs that are associated with the + volume. + + +'> + + + + The volume status. + + + + + + + The volume migration status. + + + + + + + The UUID of the user. + + + + + + + Instance attachment information. + + + If this volume is attached to a server instance, the attachments list + includes the UUID of the attached server, an attachment UUID, the name + of the attached host, if any, the volume UUID, the device, and the + device UUID. + + + Otherwise, this list is empty. + + + + + + + The volume links. + + + + + + + The availability zone. + + + + + + + Enables or disables the bootable attribute. + You can boot an instance from a bootable volume. + + + + + + + If true, this volume is encrypted. + + + +&created_at-ResponseParameter; + + + + The volume description. + + + +&updated_at-ResponseParameter; + + + + The volume type. In an environment with multiple-storage back ends, the + scheduler determines where to send the volume based on the volume + type. + + + For information about how to use volume types to create multiple-storage + back ends, see Configure + multiple-storage back ends. + + + + + + + The volume name. + + + + + + + The volume replication status. + + + + + + + The UUID of the consistency group. + + + + + + + The UUID of the source volume. + + + + + + + The UUID of the source volume snapshot. The API creates a new volume + snapshot with the same size as the source volume snapshot. + + + + + + + If true, this volume can attach to more than one instance. + + + + + + + One or more metadata key and value pairs that are associated with the + volume. + + + + + + + The UUID of the volume. + + + + + + + The size of the volume, in gibibytes (GiB). + + +'> + + + + + + + + + The name of the volume type. + + + + + + + A set of key and value pairs that contains the specifications for a + volume type. + + +'> + + + + @@ -2858,3 +2738,30 @@ '> + + + + The volume type access. Set to true if access is public. + Set to false if access is private. Default is + true. + + +'> + + + + The volume type access. If set to true, access is public. + If set to false, access is private. + + +'> diff --git a/api-ref/src/wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl b/api-ref/src/wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl index 9cf8c615f..7495ba953 100644 --- a/api-ref/src/wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl +++ b/api-ref/src/wadls/volume-api/src/v1/wadl/os-quota-sets-v1.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -21,7 +21,7 @@ path="os-quota-sets"> - &tenant_idAdminTemplateParameter; + &admin_tenant_idTemplateParameter; @@ -31,7 +31,7 @@ - &tenant_idAdminTemplateParameter; + &admin_tenant_idTemplateParameter; &user_idTemplateParameter; @@ -55,8 +55,7 @@ - Shows default quotas for a - tenant. + Shows default quotas for a tenant. @@ -76,7 +75,9 @@ - "aSetsResponseParameters; + + "aSetsResponseParameters; + @@ -108,7 +109,6 @@ /> "aSetsResponseParameters; - &in_useResponseParameter; &reservedResponseParameter; diff --git a/api-ref/src/wadls/volume-api/src/v1/wadl/volumes-v1.wadl b/api-ref/src/wadls/volume-api/src/v1/wadl/volumes-v1.wadl index cd9a05063..4653cfe8e 100644 --- a/api-ref/src/wadls/volume-api/src/v1/wadl/volumes-v1.wadl +++ b/api-ref/src/wadls/volume-api/src/v1/wadl/volumes-v1.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -147,7 +147,7 @@ - &volumeObject; + &volumeObjectParameter; &createVolumeRequestParameters; @@ -161,8 +161,8 @@ - &volumeObject; - &volumeResponseParameters; + &volumeObjectParameter; + &createVolumeResponseParameters; @@ -182,7 +182,7 @@ - &volumesObject; + &volumesObjectParameter; &volumeSimpleResponseParameters; @@ -204,7 +204,7 @@ - &volumesObject; + &volumesObjectParameter; &volumeResponseParameters; @@ -226,7 +226,7 @@ - &volumeObject; + &volumeObjectParameter; &volumeResponseParameters; @@ -343,7 +343,6 @@ &volume_typeRequestParameters; - &extra_specsRequestParameter; @@ -356,7 +355,6 @@ - &volume_typeObject; &volume_typeResponseParameters; @@ -405,7 +403,7 @@ - &snapshotObject; + &snapshotObjectParameter; @@ -524,7 +522,7 @@ - &metadataRequestParameter; + &snapshot-metadataRequestParameter; diff --git a/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-request.json b/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-request.json index 1a03f2605..38c12d9a7 100644 --- a/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-request.json +++ b/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-request.json @@ -1,19 +1,16 @@ { "volume": { - "status": "creating", - "description": null, + "size": 10, "availability_zone": null, "source_volid": null, - "consistencygroup_id": null, + "description": null, + "multiattach ": false, "snapshot_id": null, - "source_replica": null, - "size": 10, - "user_id": null, "name": null, "imageRef": null, - "attach_status": "detached", "volume_type": null, - "project_id": null, - "metadata": {} + "metadata": {}, + "source_replica": null, + "consistencygroup_id": null } } diff --git a/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-response.json b/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-response.json index 4a55bd646..a4f4de88b 100644 --- a/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-response.json +++ b/api-ref/src/wadls/volume-api/src/v2/samples/volumes/volume-create-response.json @@ -1,6 +1,8 @@ { "volume": { + "status": "creating", "migration_status": null, + "user_id": "0eea4eabcf184061a3b6db1e0daaf010", "attachments": [], "links": [ { @@ -13,27 +15,20 @@ } ], "availability_zone": "nova", - "os-vol-host-attr:host": null, - "encrypted": false, - "os-volume-replication:extended_status": null, - "replication_status": "disabled", - "snapshot_id": null, - "id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", - "size": 2, - "user_id": "32779452fcd34ae1a53a797ac8a1e064", - "os-vol-tenant-attr:tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978", - "os-vol-mig-status-attr:migstat": null, - "metadata": {}, - "status": "creating", - "description": null, - "multiattach": true, - "os-volume-replication:driver_data": null, - "source_volid": null, - "consistencygroup_id": null, - "os-vol-mig-status-attr:name_id": null, - "name": "test-volume-attachments", "bootable": "false", + "encrypted": false, "created_at": "2015-11-29T03:01:44.000000", - "volume_type": "lvmdriver-1" + "description": null, + "updated_at": null, + "volume_type": "lvmdriver-1", + "name": "test-volume-attachments", + "replication_status": "disabled", + "consistencygroup_id": null, + "source_volid": null, + "snapshot_id": null, + "multiattach": false, + "metadata": {}, + "id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", + "size": 2 } } diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/backups-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/backups-v2.wadl index 9cbb64abd..1e360ba3e 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/backups-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/backups-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/capabilities-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/capabilities-v2.wadl index 7cc42d7b6..54f3be6a8 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/capabilities-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/capabilities-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/cgsnapshots-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/cgsnapshots-v2.wadl index 91fb72146..886af3d7a 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/cgsnapshots-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/cgsnapshots-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -49,9 +49,7 @@ href="../samples/cgsnapshots/cgsnapshots-list-response.json" /> - - - &consistencyGroupSnapshotResponseParameters; + &consistencyGroupSnapshotsResponseParameters; @@ -72,7 +70,7 @@ - &consistencyGroupSnapshotDetailResponseParameters; + &consistencyGroupSnapshotsResponseDetailParameters; @@ -105,7 +103,7 @@ - &consistencyGroupSnapshotResponseParameters; + &consistencyGroupSnapshotsResponseDetailParameters; @@ -136,7 +134,7 @@ - &consistencyGroupSnapshotDetailResponseParameters; + &consistencyGroupSnapshotsResponseDetailParameters; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/consistencygroups-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/consistencygroups-v2.wadl index 397fc8e5e..93ba3d02a 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/consistencygroups-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/consistencygroups-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -19,22 +19,22 @@ &tenant_idTemplateParameter; - - + + - + - + &consistencygroup_idTemplateParameter; - + - + - + @@ -42,7 +42,7 @@ - + @@ -57,13 +57,11 @@ href="../samples/consistencygroups/consistency-groups-list-response.json" /> - - - &consistencyGroupsResponseParameters; + &consistencyGroupResponseParameters; - + @@ -78,13 +76,11 @@ href="../samples/consistencygroups/consistency-groups-list-detailed-response.json" /> - - - &consistencyGroupsDetailsResponseParameters; + &consistencyGroupDetailResponseParameters; - + @@ -99,8 +95,6 @@ href="../samples/consistencygroups/consistency-group-create-request.json" /> - - &consistencyGroupCreateRequestParameters; @@ -114,7 +108,7 @@ - + @@ -129,8 +123,6 @@ href="../samples/consistencygroups/consistency-group-create-from-src-request.json" /> - - &consistencyGroupCreateFromSourceRequestParameters; @@ -144,7 +136,7 @@ - + @@ -159,15 +151,13 @@ href="../samples/consistencygroups/consistency-group-delete-request.json" /> - - &forceRequestParameter; - + @@ -181,13 +171,13 @@ - &consistencyGroupUpdateRequestParameters; + &consistencyGroupUpdateParameters; - + @@ -202,9 +192,7 @@ href="../samples/consistencygroups/consistency-group-show-response.json" /> - - - &consistencyGroupsDetailsResponseParameters; + &consistencyGroupDetailResponseParameters; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/limits-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/limits-v2.wadl index 8ff6a1424..65e002f35 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/limits-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/limits-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -35,8 +35,8 @@ absolute limit for the item is infinite. - &limitsResponseParameters; - + + @@ -44,6 +44,7 @@ href="../samples/limits/limits-show-response.json" /> + &limitsResponseParameters; + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl index c7209b038..ae0adb8e2 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/os-quota-sets-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -18,7 +18,7 @@ &tenant_idTemplateParameter; - &tenant_idAdminTemplateParameter; + &admin_tenant_idTemplateParameter; @@ -27,7 +27,7 @@ - &tenant_idAdminTemplateParameter; + &admin_tenant_idTemplateParameter; &user_idTemplateParameter; @@ -35,8 +35,7 @@ - + &user_idTemplateParameter; @@ -104,7 +103,6 @@ /> "aSetsResponseParameters; - &in_useResponseParameter; &reservedResponseParameter; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/os-vol-image-meta-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/os-vol-image-meta-v2.wadl index 6be528c4f..43829b2b3 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/os-vol-image-meta-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/os-vol-image-meta-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-manage-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-manage-v2.wadl index 8a9993013..05505bdbc 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-manage-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-manage-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-transfer-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-transfer-v2.wadl index 5bfb63d41..a8413f884 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-transfer-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/os-volume-transfer-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl index 1861a3ace..24291bd02 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/qos-specs-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -76,7 +76,7 @@ - &qos_specsObject; + &qos_specsObjectParameter; - &qos_specsObject; + &qos_specsObjectParameter; - &qos_specsObject; + &qos_specsObjectParameter; - &qos_specsObject; + &qos_specsObjectParameter; - &qos_specsObject; + &qos_specsObjectParameter; + %common; %common_project; diff --git a/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl b/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl index dab390325..894f4e0fb 100644 --- a/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl +++ b/api-ref/src/wadls/volume-api/src/v2/wadl/volumes-v2.wadl @@ -1,7 +1,7 @@ + %common; %common_project; @@ -281,7 +281,6 @@ - &volumeObject; &createVolumeRequestParameters; @@ -301,7 +300,7 @@ href="../samples/volumes/volume-create-response.xml" /> - &volumeObject; + &volumeObjectParameter; &volumeResponseParameters; @@ -336,7 +335,7 @@ href="../samples/volumes/volumes-list-response.json" /> - &volumesObject; + &volumesObjectParameter; &volumeSimpleResponseParameters; @@ -371,7 +370,7 @@ href="../samples/volumes/volumes-list-detailed-response.json" /> - &volumesObject; + &volumesObjectParameter; &volumeResponseParameters; @@ -405,7 +404,7 @@ - &volumeObject; + &volumeObjectParameter; &volumeResponseParameters; @@ -451,7 +450,7 @@ href="../samples/volumes/volume-update-response.json" /> - &volumeObject; + &volumeObjectParameter; &volumeResponseParameters; @@ -489,9 +488,14 @@ Troubleshooting - If volume status remains in deleting or - becomes error_deleting the request failed. Ensure you meet - the preconditions then investigate the storage back end. + + + If volume status remains in deleting or + becomes error_deleting the request + failed. Ensure you meet the preconditions then + investigate the storage back end. + + The volume managed by OpenStack Block Storage is not deleted from the storage system. @@ -773,7 +777,7 @@ href="../samples/volumes/volume-attach-request.json" /> - &os-attachVolumeRequestParameters; + &attachVolumeReqParameters; @@ -829,7 +833,7 @@ href="../samples/volumes/volume-force-detach-request.json" /> - &os-force_detachVolumeRequestParameters; + &os-force_detachRequestParameter; @@ -900,7 +904,7 @@ href="../samples/volumes/volume-types-list-response.json" /> - &volume_typesObject; + &volume_typesObjectParameter; &volume_typeResponseParameters; @@ -941,7 +945,7 @@ - &volume_typeObject; + &volume_typeObjectParameter; @@ -956,7 +960,7 @@ xml:lang="EN"> - &volume_typeObject; + &volume_typeObjectParameter; &volume_typeResponseParameters; @@ -1206,7 +1210,7 @@ href="../samples/volumes/snapshot-create-response.json" /> - &snapshotObject; + &snapshotObjectParameter; &snapshotResponseParameters; @@ -1315,7 +1319,7 @@ href="../samples/volumes/snapshot-show-response.json" /> - &snapshotObject; + &snapshotObjectParameter; &snapshotResponseParameters; @@ -1419,7 +1423,7 @@ href="../samples/volumes/snapshot-update-response.json" /> - &snapshotObject; + &snapshotObjectParameter; &snapshotResponseParameters; @@ -1456,7 +1460,7 @@ href="../samples/volumes/snapshot-metadata-show-response.json" /> - &snapshotObject; + &snapshotObjectParameter; &snapshotResponseParameters;