Api-ref: change 'tenant' to 'project' in v2 doc
Since 'tenant' is the old term, all things should now refer to 'project'. Change-Id: I3a255df758583a3c4301041c8ebffb90b8263fef
This commit is contained in:
parent
88011280e8
commit
4403ed17ca
@ -9,7 +9,7 @@ Shows capabilities for a storage back end.
|
|||||||
Show back-end capabilities
|
Show back-end capabilities
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/capabilities/{hostname}
|
.. rest_method:: GET /v2/{project_id}/capabilities/{hostname}
|
||||||
|
|
||||||
Shows capabilities for a storage back end on the host.
|
Shows capabilities for a storage back end on the host.
|
||||||
The ``hostname`` takes the form of ``hostname@volume_backend_name``.
|
The ``hostname`` takes the form of ``hostname@volume_backend_name``.
|
||||||
@ -22,7 +22,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- hostname: hostname
|
- hostname: hostname
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
@ -17,7 +17,7 @@ to limit roles.
|
|||||||
List consistency groups
|
List consistency groups
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/consistencygroups
|
.. rest_method:: GET /v2/{project_id}/consistencygroups
|
||||||
|
|
||||||
Lists consistency groups.
|
Lists consistency groups.
|
||||||
|
|
||||||
@ -30,7 +30,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@ -55,7 +55,7 @@ Response Example
|
|||||||
Create consistency group
|
Create consistency group
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/consistencygroups
|
.. rest_method:: POST /v2/{project_id}/consistencygroups
|
||||||
|
|
||||||
Creates a consistency group.
|
Creates a consistency group.
|
||||||
|
|
||||||
@ -67,7 +67,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- description: description_6
|
- description: description_6
|
||||||
- availability_zone: availability_zone
|
- availability_zone: availability_zone
|
||||||
- volume_types: volume_types_2
|
- volume_types: volume_types_2
|
||||||
@ -101,7 +101,7 @@ Response Example
|
|||||||
Show consistency group details
|
Show consistency group details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/consistencygroups/{consistencygroup_id}
|
.. rest_method:: GET /v2/{project_id}/consistencygroups/{consistencygroup_id}
|
||||||
|
|
||||||
Shows details for a consistency group.
|
Shows details for a consistency group.
|
||||||
|
|
||||||
@ -112,7 +112,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- consistencygroup_id: consistencygroup_id
|
- consistencygroup_id: consistencygroup_id
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -138,7 +138,7 @@ Response Example
|
|||||||
Create consistency group from source
|
Create consistency group from source
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/consistencygroups/create_from_src
|
.. rest_method:: POST /v2/{project_id}/consistencygroups/create_from_src
|
||||||
|
|
||||||
Creates a consistency group from source.
|
Creates a consistency group from source.
|
||||||
|
|
||||||
@ -155,9 +155,9 @@ Request
|
|||||||
- description: description
|
- description: description
|
||||||
- cgsnapshot_id: cgsnapshot_id
|
- cgsnapshot_id: cgsnapshot_id
|
||||||
- source_cgid: source_cgid
|
- source_cgid: source_cgid
|
||||||
- project_id: project_id
|
- project_id: project_id_path
|
||||||
- name: name
|
- name: name
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -169,7 +169,7 @@ Request Example
|
|||||||
Delete consistency group
|
Delete consistency group
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/consistencygroups/{consistencygroup_id}/delete
|
.. rest_method:: POST /v2/{project_id}/consistencygroups/{consistencygroup_id}/delete
|
||||||
|
|
||||||
Deletes a consistency group.
|
Deletes a consistency group.
|
||||||
|
|
||||||
@ -182,7 +182,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- force: force
|
- force: force
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- consistencygroup_id: consistencygroup_id
|
- consistencygroup_id: consistencygroup_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -195,7 +195,7 @@ Request Example
|
|||||||
List consistency groups with details
|
List consistency groups with details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/consistencygroups/detail
|
.. rest_method:: GET /v2/{project_id}/consistencygroups/detail
|
||||||
|
|
||||||
Lists consistency groups with details.
|
Lists consistency groups with details.
|
||||||
|
|
||||||
@ -208,7 +208,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@ -238,7 +238,7 @@ Response Example
|
|||||||
Update consistency group
|
Update consistency group
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/consistencygroups/{consistencygroup_id}/update
|
.. rest_method:: PUT /v2/{project_id}/consistencygroups/{consistencygroup_id}/update
|
||||||
|
|
||||||
Updates a consistency group.
|
Updates a consistency group.
|
||||||
|
|
||||||
@ -254,7 +254,7 @@ Request
|
|||||||
- description: description
|
- description: description
|
||||||
- add_volumes: add_volumes
|
- add_volumes: add_volumes
|
||||||
- name: name
|
- name: name
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- consistencygroup_id: consistencygroup_id
|
- consistencygroup_id: consistencygroup_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
|
@ -9,7 +9,7 @@ Force-deletes a backup and reset status for a backup.
|
|||||||
Force-delete backup
|
Force-delete backup
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/backups/{backup_id}/action
|
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/action
|
||||||
|
|
||||||
Force-deletes a backup. Specify the ``os-force_delete`` action in the request body.
|
Force-deletes a backup. Specify the ``os-force_delete`` action in the request body.
|
||||||
|
|
||||||
@ -29,7 +29,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- os-force_delete: os-force_delete
|
- os-force_delete: os-force_delete
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- backup_id: backup_id
|
- backup_id: backup_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -43,7 +43,7 @@ Request Example
|
|||||||
Reset backup's status
|
Reset backup's status
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/backups/{backup_id}/action
|
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/action
|
||||||
|
|
||||||
Reset a backup's status. Specify the ``os-reset_status`` action in the request body.
|
Reset a backup's status. Specify the ``os-reset_status`` action in the request body.
|
||||||
|
|
||||||
@ -59,7 +59,7 @@ Request
|
|||||||
|
|
||||||
- status: status_7
|
- status: status_7
|
||||||
- os-reset_status: os-reset_status
|
- os-reset_status: os-reset_status
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- backup_id: backup_id
|
- backup_id: backup_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
|
@ -40,9 +40,9 @@ in the ``fail_reason`` field for the backup.
|
|||||||
List backups with details
|
List backups with details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/backups/detail
|
.. rest_method:: GET /v2/{project_id}/backups/detail
|
||||||
|
|
||||||
Lists Block Storage backups, with details, to which the tenant has access.
|
Lists Block Storage backups, with details, to which the project has access.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -53,7 +53,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@ -94,7 +94,7 @@ Response Example
|
|||||||
Show backup details
|
Show backup details
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/backups/{backup_id}
|
.. rest_method:: GET /v2/{project_id}/backups/{backup_id}
|
||||||
|
|
||||||
Shows details for a backup.
|
Shows details for a backup.
|
||||||
|
|
||||||
@ -107,7 +107,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- backup_id: backup_id
|
- backup_id: backup_id
|
||||||
|
|
||||||
|
|
||||||
@ -145,7 +145,7 @@ Response Example
|
|||||||
Delete backup
|
Delete backup
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/backups/{backup_id}
|
.. rest_method:: DELETE /v2/{project_id}/backups/{backup_id}
|
||||||
|
|
||||||
Deletes a backup.
|
Deletes a backup.
|
||||||
|
|
||||||
@ -161,14 +161,14 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- backup_id: backup_id
|
- backup_id: backup_id
|
||||||
|
|
||||||
|
|
||||||
Restore backup
|
Restore backup
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/backups/{backup_id}/restore
|
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/restore
|
||||||
|
|
||||||
Restores a Block Storage backup to an existing or new Block Storage volume.
|
Restores a Block Storage backup to an existing or new Block Storage volume.
|
||||||
|
|
||||||
@ -188,7 +188,7 @@ Request
|
|||||||
- restore: restore
|
- restore: restore
|
||||||
- name: name_1
|
- name: name_1
|
||||||
- volume_id: volume_id
|
- volume_id: volume_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- backup_id: backup_id
|
- backup_id: backup_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -216,7 +216,7 @@ Response Example
|
|||||||
Create backup
|
Create backup
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/backups
|
.. rest_method:: POST /v2/{project_id}/backups
|
||||||
|
|
||||||
Creates a Block Storage backup from a volume.
|
Creates a Block Storage backup from a volume.
|
||||||
|
|
||||||
@ -236,7 +236,7 @@ Request
|
|||||||
- force: force
|
- force: force
|
||||||
- backup: backup
|
- backup: backup
|
||||||
- name: name_1
|
- name: name_1
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id_2
|
- snapshot_id: snapshot_id_2
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -258,9 +258,9 @@ Response Parameters
|
|||||||
List backups
|
List backups
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/backups
|
.. rest_method:: GET /v2/{project_id}/backups
|
||||||
|
|
||||||
Lists Block Storage backups to which the tenant has access.
|
Lists Block Storage backups to which the project has access.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
|
||||||
@ -269,7 +269,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
|
@ -11,7 +11,7 @@ Lists, shows hosts.
|
|||||||
List all hosts
|
List all hosts
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{admin_tenant_id}/os-hosts
|
.. rest_method:: GET /v2/{admin_project_id}/os-hosts
|
||||||
|
|
||||||
Lists all hosts summary info that is not disabled.
|
Lists all hosts summary info that is not disabled.
|
||||||
|
|
||||||
@ -24,7 +24,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -48,7 +48,7 @@ Response Example
|
|||||||
Show Host Details
|
Show Host Details
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{admin_tenant_id}/os-hosts/{host_name}
|
.. rest_method:: GET /v2/{admin_project_id}/os-hosts/{host_name}
|
||||||
|
|
||||||
Shows volume and snapshot details for a cinder-volume host.
|
Shows volume and snapshot details for a cinder-volume host.
|
||||||
|
|
||||||
@ -65,7 +65,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
- host_name: hostname
|
- host_name: hostname
|
||||||
|
|
||||||
Response
|
Response
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
Limits (limits)
|
Limits (limits)
|
||||||
===============
|
===============
|
||||||
|
|
||||||
Shows absolute limits for a tenant.
|
Shows absolute limits for a project.
|
||||||
|
|
||||||
An absolute limit value of ``-1`` indicates that the absolute limit
|
An absolute limit value of ``-1`` indicates that the absolute limit
|
||||||
for the item is infinite.
|
for the item is infinite.
|
||||||
@ -12,9 +12,9 @@ for the item is infinite.
|
|||||||
Show absolute limits
|
Show absolute limits
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/limits
|
.. rest_method:: GET /v2/{project_id}/limits
|
||||||
|
|
||||||
Shows absolute limits for a tenant.
|
Shows absolute limits for a project.
|
||||||
|
|
||||||
An absolute limit value of ``-1`` indicates that the absolute limit
|
An absolute limit value of ``-1`` indicates that the absolute limit
|
||||||
for the item is infinite.
|
for the item is infinite.
|
||||||
@ -29,7 +29,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
@ -10,7 +10,7 @@ deletes consistency group snapshots.
|
|||||||
Delete consistency group snapshot
|
Delete consistency group snapshot
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/cgsnapshots/{cgsnapshot_id}
|
.. rest_method:: DELETE /v2/{project_id}/cgsnapshots/{cgsnapshot_id}
|
||||||
|
|
||||||
Deletes a consistency group snapshot.
|
Deletes a consistency group snapshot.
|
||||||
|
|
||||||
@ -22,14 +22,14 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- cgsnapshot_id: cgsnapshot_id
|
- cgsnapshot_id: cgsnapshot_id
|
||||||
|
|
||||||
|
|
||||||
Show consistency group snapshot details
|
Show consistency group snapshot details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/cgsnapshots/{cgsnapshot_id}
|
.. rest_method:: GET /v2/{project_id}/cgsnapshots/{cgsnapshot_id}
|
||||||
|
|
||||||
Shows details for a consistency group snapshot.
|
Shows details for a consistency group snapshot.
|
||||||
|
|
||||||
@ -42,7 +42,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- cgsnapshot_id: cgsnapshot_id
|
- cgsnapshot_id: cgsnapshot_id
|
||||||
|
|
||||||
|
|
||||||
@ -68,7 +68,7 @@ Response Example
|
|||||||
List consistency group snapshots with details
|
List consistency group snapshots with details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/cgsnapshots/detail
|
.. rest_method:: GET /v2/{project_id}/cgsnapshots/detail
|
||||||
|
|
||||||
Lists all consistency group snapshots with details.
|
Lists all consistency group snapshots with details.
|
||||||
|
|
||||||
@ -80,7 +80,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -104,7 +104,7 @@ Response Example
|
|||||||
List consistency group snapshots
|
List consistency group snapshots
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/cgsnapshots
|
.. rest_method:: GET /v2/{project_id}/cgsnapshots
|
||||||
|
|
||||||
Lists all consistency group snapshots.
|
Lists all consistency group snapshots.
|
||||||
|
|
||||||
@ -117,7 +117,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -142,7 +142,7 @@ Response Example
|
|||||||
Create consistency group snapshot
|
Create consistency group snapshot
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/cgsnapshots
|
.. rest_method:: POST /v2/{project_id}/cgsnapshots
|
||||||
|
|
||||||
Creates a consistency group snapshot.
|
Creates a consistency group snapshot.
|
||||||
|
|
||||||
@ -154,7 +154,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
- name: name
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -10,7 +10,7 @@ to the scheduler service.
|
|||||||
List back-end storage pools
|
List back-end storage pools
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/scheduler-stats/get_pools
|
.. rest_method:: GET /v2/{project_id}/scheduler-stats/get_pools
|
||||||
|
|
||||||
Lists all back-end storage pools.
|
Lists all back-end storage pools.
|
||||||
|
|
||||||
@ -22,7 +22,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- detail: detail
|
- detail: detail
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
@ -9,7 +9,7 @@ Transfers a volume from one user to another user.
|
|||||||
Accept volume transfer
|
Accept volume transfer
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/os-volume-transfer/{transfer_id}/accept
|
.. rest_method:: POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept
|
||||||
|
|
||||||
Accepts a volume transfer.
|
Accepts a volume transfer.
|
||||||
|
|
||||||
@ -23,7 +23,7 @@ Request
|
|||||||
|
|
||||||
- auth_key: auth_key
|
- auth_key: auth_key
|
||||||
- transfer_id: transfer_id
|
- transfer_id: transfer_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -47,7 +47,7 @@ Response Parameters
|
|||||||
Create volume transfer
|
Create volume transfer
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/os-volume-transfer
|
.. rest_method:: POST /v2/{project_id}/os-volume-transfer
|
||||||
|
|
||||||
Creates a volume transfer.
|
Creates a volume transfer.
|
||||||
|
|
||||||
@ -61,7 +61,7 @@ Request
|
|||||||
|
|
||||||
- name: name
|
- name: name
|
||||||
- volume_id: volume_id
|
- volume_id: volume_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -86,7 +86,7 @@ Response Parameters
|
|||||||
List volume transfers
|
List volume transfers
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/os-volume-transfer
|
.. rest_method:: GET /v2/{project_id}/os-volume-transfer
|
||||||
|
|
||||||
Lists volume transfers.
|
Lists volume transfers.
|
||||||
|
|
||||||
@ -99,7 +99,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -123,7 +123,7 @@ Response Example
|
|||||||
Show volume transfer details
|
Show volume transfer details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/os-volume-transfer/{transfer_id}
|
.. rest_method:: GET /v2/{project_id}/os-volume-transfer/{transfer_id}
|
||||||
|
|
||||||
Shows details for a volume transfer.
|
Shows details for a volume transfer.
|
||||||
|
|
||||||
@ -137,7 +137,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- transfer_id: transfer_id
|
- transfer_id: transfer_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -162,7 +162,7 @@ Response Example
|
|||||||
Delete volume transfer
|
Delete volume transfer
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/os-volume-transfer/{transfer_id}
|
.. rest_method:: DELETE /v2/{project_id}/os-volume-transfer/{transfer_id}
|
||||||
|
|
||||||
Deletes a volume transfer.
|
Deletes a volume transfer.
|
||||||
|
|
||||||
@ -175,13 +175,13 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- transfer_id: transfer_id
|
- transfer_id: transfer_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
List volume transfers, with details
|
List volume transfers, with details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/os-volume-transfer/detail
|
.. rest_method:: GET /v2/{project_id}/os-volume-transfer/detail
|
||||||
|
|
||||||
Lists volume transfers, with details.
|
Lists volume transfers, with details.
|
||||||
|
|
||||||
@ -193,7 +193,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
@ -7,9 +7,9 @@ x-openstack-request-id:
|
|||||||
type: string
|
type: string
|
||||||
|
|
||||||
# variables in path
|
# variables in path
|
||||||
admin_tenant_id:
|
admin_project_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the administrative tenant.
|
The UUID of the administrative project.
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
@ -55,7 +55,7 @@ hostname:
|
|||||||
The name of the host that hosts the storage back
|
The name of the host that hosts the storage back
|
||||||
end.
|
end.
|
||||||
in: path
|
in: path
|
||||||
required: false
|
required: true
|
||||||
type: string
|
type: string
|
||||||
key_1:
|
key_1:
|
||||||
description: |
|
description: |
|
||||||
@ -96,18 +96,12 @@ quota_class_name:
|
|||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
quotas_tenant_id:
|
quotas_project_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the tenant in a multi-tenancy cloud.
|
The UUID of the project in a multi-tenancy cloud.
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
tenant_id:
|
|
||||||
description: |
|
|
||||||
The UUID of the tenant in a multi-tenancy cloud.
|
|
||||||
in: path
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
transfer_id:
|
transfer_id:
|
||||||
description: |
|
description: |
|
||||||
The unique identifier for a volume transfer.
|
The unique identifier for a volume transfer.
|
||||||
@ -155,7 +149,7 @@ action:
|
|||||||
type: string
|
type: string
|
||||||
all-tenants:
|
all-tenants:
|
||||||
description: |
|
description: |
|
||||||
Shows details for all tenants. Admin only..
|
Shows details for all projects. Admin only.
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
@ -424,7 +418,7 @@ control_location:
|
|||||||
cores:
|
cores:
|
||||||
description: |
|
description: |
|
||||||
The number of instance cores that are allowed for
|
The number of instance cores that are allowed for
|
||||||
each tenant.
|
each project.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
@ -617,7 +611,7 @@ fail_reason:
|
|||||||
fixed_ips:
|
fixed_ips:
|
||||||
description: |
|
description: |
|
||||||
The number of fixed IP addresses that are allowed
|
The number of fixed IP addresses that are allowed
|
||||||
for each tenant. Must be equal to or greater than the number of
|
for each project. Must be equal to or greater than the number of
|
||||||
allowed instances.
|
allowed instances.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
@ -625,7 +619,7 @@ fixed_ips:
|
|||||||
floating_ips:
|
floating_ips:
|
||||||
description: |
|
description: |
|
||||||
The number of floating IP addresses that are
|
The number of floating IP addresses that are
|
||||||
allowed for each tenant.
|
allowed for each project.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
@ -777,7 +771,7 @@ injected_file_path_bytes:
|
|||||||
injected_files:
|
injected_files:
|
||||||
description: |
|
description: |
|
||||||
The number of injected files that are allowed for
|
The number of injected files that are allowed for
|
||||||
each tenant.
|
each project.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
@ -790,7 +784,7 @@ instance_uuid:
|
|||||||
instances:
|
instances:
|
||||||
description: |
|
description: |
|
||||||
The number of instances that are allowed for each
|
The number of instances that are allowed for each
|
||||||
tenant.
|
project.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
@ -1295,7 +1289,7 @@ os-vol-mig-status-attr:name_id:
|
|||||||
type: string
|
type: string
|
||||||
os-vol-tenant-attr:tenant_id:
|
os-vol-tenant-attr:tenant_id:
|
||||||
description: |
|
description: |
|
||||||
The tenant ID which the volume belongs to.
|
The project ID which the volume belongs to.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
@ -1403,7 +1397,7 @@ quota_set:
|
|||||||
ram:
|
ram:
|
||||||
description: |
|
description: |
|
||||||
The amount of instance RAM in megabytes that are
|
The amount of instance RAM in megabytes that are
|
||||||
allowed for each tenant.
|
allowed for each project.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
@ -1482,7 +1476,7 @@ security_group_rules:
|
|||||||
security_groups:
|
security_groups:
|
||||||
description: |
|
description: |
|
||||||
The number of security groups that are allowed
|
The number of security groups that are allowed
|
||||||
for each tenant.
|
for each project.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: integer
|
type: integer
|
||||||
|
@ -13,7 +13,7 @@ specifications.
|
|||||||
Disassociate QoS specification from all associations
|
Disassociate QoS specification from all associations
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/disassociate_all
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/disassociate_all
|
||||||
|
|
||||||
Disassociates a QoS specification from all associations.
|
Disassociates a QoS specification from all associations.
|
||||||
|
|
||||||
@ -25,14 +25,14 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
|
|
||||||
|
|
||||||
Unset keys in QoS specification
|
Unset keys in QoS specification
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/qos-specs/{qos_id}/delete_keys
|
.. rest_method:: PUT /v2/{project_id}/qos-specs/{qos_id}/delete_keys
|
||||||
|
|
||||||
Unsets keys in a QoS specification.
|
Unsets keys in a QoS specification.
|
||||||
|
|
||||||
@ -46,7 +46,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- keys: keys
|
- keys: keys
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -67,7 +67,7 @@ Response Example
|
|||||||
Get all associations for QoS specification
|
Get all associations for QoS specification
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/associations
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/associations
|
||||||
|
|
||||||
Lists all associations for a QoS specification.
|
Lists all associations for a QoS specification.
|
||||||
|
|
||||||
@ -80,7 +80,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
|
|
||||||
|
|
||||||
@ -94,7 +94,7 @@ Response Example
|
|||||||
Associate QoS specification with volume type
|
Associate QoS specification with volume type
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/associate
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/associate
|
||||||
|
|
||||||
Associates a QoS specification with a volume type.
|
Associates a QoS specification with a volume type.
|
||||||
|
|
||||||
@ -106,7 +106,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
- vol_type_id: vol_type_id
|
- vol_type_id: vol_type_id
|
||||||
|
|
||||||
@ -114,7 +114,7 @@ Request
|
|||||||
Disassociate QoS specification from volume type
|
Disassociate QoS specification from volume type
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/disassociate
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}/disassociate
|
||||||
|
|
||||||
Disassociates a QoS specification from a volume type.
|
Disassociates a QoS specification from a volume type.
|
||||||
|
|
||||||
@ -126,7 +126,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
- vol_type_id: vol_type_id
|
- vol_type_id: vol_type_id
|
||||||
|
|
||||||
@ -134,7 +134,7 @@ Request
|
|||||||
Show QoS specification details
|
Show QoS specification details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}
|
.. rest_method:: GET /v2/{project_id}/qos-specs/{qos_id}
|
||||||
|
|
||||||
Shows details for a QoS specification.
|
Shows details for a QoS specification.
|
||||||
|
|
||||||
@ -149,7 +149,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
|
|
||||||
|
|
||||||
@ -176,7 +176,7 @@ Response Example
|
|||||||
Set keys in QoS specification
|
Set keys in QoS specification
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/qos-specs/{qos_id}
|
.. rest_method:: PUT /v2/{project_id}/qos-specs/{qos_id}
|
||||||
|
|
||||||
Sets keys in a QoS specification.
|
Sets keys in a QoS specification.
|
||||||
|
|
||||||
@ -191,7 +191,7 @@ Request
|
|||||||
|
|
||||||
- qos_specs: qos_specs
|
- qos_specs: qos_specs
|
||||||
- specs: specs
|
- specs: specs
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -211,7 +211,7 @@ Response Example
|
|||||||
Delete QoS specification
|
Delete QoS specification
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/qos-specs/{qos_id}
|
.. rest_method:: DELETE /v2/{project_id}/qos-specs/{qos_id}
|
||||||
|
|
||||||
Deletes a QoS specification.
|
Deletes a QoS specification.
|
||||||
|
|
||||||
@ -223,7 +223,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- qos_id: qos_id
|
- qos_id: qos_id
|
||||||
- force: force
|
- force: force
|
||||||
|
|
||||||
@ -231,7 +231,7 @@ Request
|
|||||||
Create QoS specification
|
Create QoS specification
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/qos-specs
|
.. rest_method:: POST /v2/{project_id}/qos-specs
|
||||||
|
|
||||||
Creates a QoS specification.
|
Creates a QoS specification.
|
||||||
|
|
||||||
@ -248,7 +248,7 @@ Request
|
|||||||
- qos_specs: qos_specs
|
- qos_specs: qos_specs
|
||||||
- consumer: consumer
|
- consumer: consumer
|
||||||
- name: name
|
- name: name
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -274,7 +274,7 @@ Response Parameters
|
|||||||
List QoS specs
|
List QoS specs
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/qos-specs
|
.. rest_method:: GET /v2/{project_id}/qos-specs
|
||||||
|
|
||||||
Lists quality of service (QoS) specifications.
|
Lists quality of service (QoS) specifications.
|
||||||
|
|
||||||
@ -287,7 +287,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
|
@ -5,14 +5,14 @@ Quota class set extension (os-quota-class-sets)
|
|||||||
|
|
||||||
Administrators only, depending on policy settings.
|
Administrators only, depending on policy settings.
|
||||||
|
|
||||||
Shows and updates quota classes for a tenant.
|
Shows and updates quota classes for a project.
|
||||||
|
|
||||||
Show quota classes
|
Show quota classes
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{admin_tenant_id}/os-quota-class-sets/{quota_class_name}
|
.. rest_method:: GET /v2/{admin_project_id}/os-quota-class-sets/{quota_class_name}
|
||||||
|
|
||||||
Shows quota class set for a tenant. If no specific value for the quota class
|
Shows quota class set for a project. If no specific value for the quota class
|
||||||
resource exists, then the default value will be reported.
|
resource exists, then the default value will be reported.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -26,7 +26,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- quota_class_name: quota_class_name
|
- quota_class_name: quota_class_name
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -53,9 +53,9 @@ Response Example
|
|||||||
Update quota classes
|
Update quota classes
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{admin_tenant_id}/os-quota-class-sets/{quota_class_name}
|
.. rest_method:: PUT /v2/{admin_project_id}/os-quota-class-sets/{quota_class_name}
|
||||||
|
|
||||||
Updates quota class set for a tenant. If the ``quota_class_name`` key does not
|
Updates quota class set for a project. If the ``quota_class_name`` key does not
|
||||||
exist, then the API will create one.
|
exist, then the API will create one.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -68,7 +68,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
- quota_class_name: quota_class_name
|
- quota_class_name: quota_class_name
|
||||||
- gigabytes: maxTotalVolumeGigabytesOptional
|
- gigabytes: maxTotalVolumeGigabytesOptional
|
||||||
- snapshots: maxTotalSnapshotsOptional
|
- snapshots: maxTotalSnapshotsOptional
|
||||||
|
@ -5,14 +5,14 @@ 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.
|
Shows, updates, and deletes quotas for a project.
|
||||||
|
|
||||||
Show quotas
|
Show quotas
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}
|
.. rest_method:: GET /v2/{admin_project_id}/os-quota-sets/{project_id}
|
||||||
|
|
||||||
Shows quotas for a tenant.
|
Shows quotas for a project.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -23,8 +23,8 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: quotas_tenant_id
|
- project_id: quotas_project_id
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
- usage: usage
|
- usage: usage
|
||||||
|
|
||||||
|
|
||||||
@ -60,9 +60,9 @@ Response Example
|
|||||||
Update quotas
|
Update quotas
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}
|
.. rest_method:: PUT /v2/{admin_project_id}/os-quota-sets/{project_id}
|
||||||
|
|
||||||
Updates quotas for a tenant.
|
Updates quotas for a project.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -89,8 +89,8 @@ Request
|
|||||||
- fixed_ips: fixed_ips
|
- fixed_ips: fixed_ips
|
||||||
- id: id
|
- id: id
|
||||||
- security_groups: security_groups
|
- security_groups: security_groups
|
||||||
- tenant_id: quotas_tenant_id
|
- project_id: quotas_project_id
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -130,9 +130,9 @@ Response Example
|
|||||||
Delete quotas
|
Delete quotas
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}
|
.. rest_method:: DELETE /v2/{admin_project_id}/os-quota-sets/{project_id}
|
||||||
|
|
||||||
Deletes quotas for a tenant so the quotas revert to default values.
|
Deletes quotas for a project so the quotas revert to default values.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -143,8 +143,8 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: quotas_tenant_id
|
- project_id: quotas_project_id
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
@ -155,9 +155,9 @@ Response Example
|
|||||||
Get default quotas
|
Get default quotas
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/defaults
|
.. rest_method:: GET /v2/{admin_project_id}/os-quota-sets/{project_id}/defaults
|
||||||
|
|
||||||
Gets default quotas for a tenant.
|
Gets default quotas for a project.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -168,8 +168,8 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: quotas_project_id
|
||||||
- admin_tenant_id: admin_tenant_id
|
- admin_project_id: admin_project_id
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"cores": 20,
|
"cores": 20,
|
||||||
"fixed_ips": -1,
|
"fixed_ips": -1,
|
||||||
"floating_ips": 10,
|
"floating_ips": 10,
|
||||||
"id": "fake_tenant",
|
"id": "fake_project",
|
||||||
"injected_file_content_bytes": 10240,
|
"injected_file_content_bytes": 10240,
|
||||||
"injected_file_path_bytes": 255,
|
"injected_file_path_bytes": 255,
|
||||||
"injected_files": 5,
|
"injected_files": 5,
|
||||||
|
@ -10,7 +10,7 @@ storage.
|
|||||||
Manage existing volume
|
Manage existing volume
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/os-volume-manage
|
.. rest_method:: POST /v2/{project_id}/os-volume-manage
|
||||||
|
|
||||||
Creates a Block Storage volume by using existing storage rather than allocating new storage.
|
Creates a Block Storage volume by using existing storage rather than allocating new storage.
|
||||||
|
|
||||||
@ -40,7 +40,7 @@ Request
|
|||||||
- host: host
|
- host: host
|
||||||
- ref: ref
|
- ref: ref
|
||||||
- metadata: metadata
|
- metadata: metadata
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -16,7 +16,7 @@ users with the administrative role and context.
|
|||||||
Add private volume type access
|
Add private volume type access
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/types/{volume_type}/action
|
.. rest_method:: POST /v2/{project_id}/types/{volume_type}/action
|
||||||
|
|
||||||
Adds private volume type access to a project.
|
Adds private volume type access to a project.
|
||||||
|
|
||||||
@ -29,7 +29,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project: project
|
- project: project
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -42,7 +42,7 @@ Request Example
|
|||||||
Remove private volume type access
|
Remove private volume type access
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/types/{volume_type}/action
|
.. rest_method:: POST /v2/{project_id}/types/{volume_type}/action
|
||||||
|
|
||||||
Removes private volume type access from a project.
|
Removes private volume type access from a project.
|
||||||
|
|
||||||
@ -55,7 +55,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- project: project
|
- project: project
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -68,7 +68,7 @@ Request Example
|
|||||||
List private volume type access details
|
List private volume type access details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/types/{volume_type}/os-volume-type-access
|
.. rest_method:: GET /v2/{project_id}/types/{volume_type}/os-volume-type-access
|
||||||
|
|
||||||
Lists project IDs that have access to private volume type.
|
Lists project IDs that have access to private volume type.
|
||||||
|
|
||||||
@ -81,7 +81,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
|
|
||||||
|
|
||||||
|
@ -9,7 +9,7 @@ API extensions (extensions)
|
|||||||
List API extensions
|
List API extensions
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/extensions
|
.. rest_method:: GET /v2/{project_id}/extensions
|
||||||
|
|
||||||
Lists Block Storage API extensions.
|
Lists Block Storage API extensions.
|
||||||
|
|
||||||
@ -22,7 +22,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
|
@ -10,7 +10,7 @@ Administrator only. Resets status for a snapshot.
|
|||||||
Reset a snapshot's status
|
Reset a snapshot's status
|
||||||
=========================
|
=========================
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
|
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
|
||||||
|
|
||||||
Resets the status. Specify the ``os-reset_status`` action in the request body.
|
Resets the status. Specify the ``os-reset_status`` action in the request body.
|
||||||
|
|
||||||
@ -24,7 +24,7 @@ Request
|
|||||||
|
|
||||||
- status: status_2
|
- status: status_2
|
||||||
- os-reset_status: os-reset_status
|
- os-reset_status: os-reset_status
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
|
@ -37,9 +37,9 @@ possible:
|
|||||||
List snapshots with details
|
List snapshots with details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/snapshots/detail
|
.. rest_method:: GET /v2/{project_id}/snapshots/detail
|
||||||
|
|
||||||
Lists all Block Storage snapshots, with details, that the tenant can access.
|
Lists all Block Storage snapshots, with details, that the project can access.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -50,7 +50,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -79,7 +79,7 @@ Response Example
|
|||||||
Create snapshot
|
Create snapshot
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/snapshots
|
.. rest_method:: POST /v2/{project_id}/snapshots
|
||||||
|
|
||||||
Creates a volume snapshot, which is a point-in-time, complete copy of a volume. You can create a volume from a snapshot.
|
Creates a volume snapshot, which is a point-in-time, complete copy of a volume. You can create a volume from a snapshot.
|
||||||
|
|
||||||
@ -96,7 +96,7 @@ Request
|
|||||||
- force: force
|
- force: force
|
||||||
- description: description
|
- description: description
|
||||||
- name: name
|
- name: name
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -123,9 +123,9 @@ Response Parameters
|
|||||||
List snapshots
|
List snapshots
|
||||||
~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/snapshots
|
.. rest_method:: GET /v2/{project_id}/snapshots
|
||||||
|
|
||||||
Lists all Block Storage snapshots, with summary information, that the tenant can access.
|
Lists all Block Storage snapshots, with summary information, that the project can access.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -136,7 +136,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@ -168,7 +168,7 @@ Response Example
|
|||||||
Show snapshot metadata
|
Show snapshot metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/snapshots/{snapshot_id}/metadata
|
.. rest_method:: GET /v2/{project_id}/snapshots/{snapshot_id}/metadata
|
||||||
|
|
||||||
Shows metadata for a snapshot.
|
Shows metadata for a snapshot.
|
||||||
|
|
||||||
@ -181,7 +181,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
|
||||||
|
|
||||||
@ -212,7 +212,7 @@ Response Example
|
|||||||
Create snapshot metadata
|
Create snapshot metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/metadata
|
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/metadata
|
||||||
|
|
||||||
Updates metadata for a snapshot.
|
Updates metadata for a snapshot.
|
||||||
|
|
||||||
@ -229,7 +229,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- metadata: metadata
|
- metadata: metadata
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -249,7 +249,7 @@ Response Example
|
|||||||
Update snapshot metadata
|
Update snapshot metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/snapshots/{snapshot_id}/metadata
|
.. rest_method:: PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata
|
||||||
|
|
||||||
Replaces all the snapshot's metadata with the key-value pairs in the request.
|
Replaces all the snapshot's metadata with the key-value pairs in the request.
|
||||||
|
|
||||||
@ -263,7 +263,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- metadata: metadata
|
- metadata: metadata
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -283,7 +283,7 @@ Response Example
|
|||||||
Show snapshot details
|
Show snapshot details
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/snapshots/{snapshot_id}
|
.. rest_method:: GET /v2/{project_id}/snapshots/{snapshot_id}
|
||||||
|
|
||||||
Shows details for a snapshot.
|
Shows details for a snapshot.
|
||||||
|
|
||||||
@ -296,7 +296,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
|
||||||
|
|
||||||
@ -327,7 +327,7 @@ Response Example
|
|||||||
Update snapshot
|
Update snapshot
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/snapshots/{snapshot_id}
|
.. rest_method:: PUT /v2/{project_id}/snapshots/{snapshot_id}
|
||||||
|
|
||||||
Updates a snapshot.
|
Updates a snapshot.
|
||||||
|
|
||||||
@ -343,7 +343,7 @@ Request
|
|||||||
- snapshot: snapshot
|
- snapshot: snapshot
|
||||||
- description: description
|
- description: description
|
||||||
- name: name
|
- name: name
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -379,7 +379,7 @@ Response Example
|
|||||||
Delete snapshot
|
Delete snapshot
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/snapshots/{snapshot_id}
|
.. rest_method:: DELETE /v2/{project_id}/snapshots/{snapshot_id}
|
||||||
|
|
||||||
Deletes a snapshot.
|
Deletes a snapshot.
|
||||||
|
|
||||||
@ -391,5 +391,5 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- snapshot_id: snapshot_id
|
- snapshot_id: snapshot_id
|
||||||
|
@ -7,7 +7,7 @@ Volume types (types)
|
|||||||
Update volume type
|
Update volume type
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/types/{volume_type_id}
|
.. rest_method:: PUT /v2/{project_id}/types/{volume_type_id}
|
||||||
|
|
||||||
Updates a volume type.
|
Updates a volume type.
|
||||||
|
|
||||||
@ -35,7 +35,7 @@ Request
|
|||||||
|
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -66,7 +66,7 @@ Response Example
|
|||||||
Update extra specs for a volume type
|
Update extra specs for a volume type
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/types/{volume_type_id}
|
.. rest_method:: PUT /v2/{project_id}/types/{volume_type_id}
|
||||||
|
|
||||||
Updates the extra specifications that are assigned to a volume type.
|
Updates the extra specifications that are assigned to a volume type.
|
||||||
|
|
||||||
@ -82,7 +82,7 @@ Request
|
|||||||
- extra_specs: extra_specs
|
- extra_specs: extra_specs
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -114,7 +114,7 @@ Response Example
|
|||||||
Show volume type details for v2
|
Show volume type details for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/types/{volume_type_id}
|
.. rest_method:: GET /v2/{project_id}/types/{volume_type_id}
|
||||||
|
|
||||||
Shows details for a volume type.
|
Shows details for a volume type.
|
||||||
|
|
||||||
@ -127,7 +127,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -152,7 +152,7 @@ Response Example
|
|||||||
Delete volume type
|
Delete volume type
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/types/{volume_type_id}
|
.. rest_method:: DELETE /v2/{project_id}/types/{volume_type_id}
|
||||||
|
|
||||||
Deletes a volume type.
|
Deletes a volume type.
|
||||||
|
|
||||||
@ -165,13 +165,13 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
List all volume types for v2
|
List all volume types for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/types
|
.. rest_method:: GET /v2/{project_id}/types
|
||||||
|
|
||||||
Lists volume types.
|
Lists volume types.
|
||||||
|
|
||||||
@ -184,7 +184,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort_key: sort_key
|
- sort_key: sort_key
|
||||||
- sort_dir: sort_dir
|
- sort_dir: sort_dir
|
||||||
- limit: limit
|
- limit: limit
|
||||||
@ -212,7 +212,7 @@ Response Example
|
|||||||
Create volume type for v2
|
Create volume type for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/types
|
.. rest_method:: POST /v2/{project_id}/types
|
||||||
|
|
||||||
Creates a volume type.
|
Creates a volume type.
|
||||||
|
|
||||||
@ -239,7 +239,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type: volume_type
|
- volume_type: volume_type
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -269,7 +269,7 @@ Response Example
|
|||||||
Show an encryption type for v2
|
Show an encryption type for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/types/{volume_type_id}/encryption
|
.. rest_method:: GET /v2/{project_id}/types/{volume_type_id}/encryption
|
||||||
|
|
||||||
Show an encryption type.
|
Show an encryption type.
|
||||||
|
|
||||||
@ -284,7 +284,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
@ -314,7 +314,7 @@ Response Example
|
|||||||
Delete an encryption type for v2
|
Delete an encryption type for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/types/{volume_type_id}/encryption/{encryption_id}
|
.. rest_method:: GET /v2/{project_id}/types/{volume_type_id}/encryption/{encryption_id}
|
||||||
|
|
||||||
Delete an encryption type.
|
Delete an encryption type.
|
||||||
|
|
||||||
@ -329,13 +329,13 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- encryption_id: encryption_id
|
- encryption_id: encryption_id
|
||||||
|
|
||||||
Create an encryption type for v2
|
Create an encryption type for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/types/{volume_type_id}/encryption
|
.. rest_method:: POST /v2/{project_id}/types/{volume_type_id}/encryption
|
||||||
|
|
||||||
Creates an encryption type.
|
Creates an encryption type.
|
||||||
|
|
||||||
@ -350,7 +350,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- encryption: encryption
|
- encryption: encryption
|
||||||
- key_size: key_size
|
- key_size: key_size
|
||||||
- provider: provider
|
- provider: provider
|
||||||
@ -387,7 +387,7 @@ Response Example
|
|||||||
Update an encryption type for v2
|
Update an encryption type for v2
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/types/{volume_type_id}/encryption/{encryption_id}
|
.. rest_method:: POST /v2/{project_id}/types/{volume_type_id}/encryption/{encryption_id}
|
||||||
|
|
||||||
Update an encryption type.
|
Update an encryption type.
|
||||||
|
|
||||||
@ -402,7 +402,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- volume_type_id: volume_type_id
|
- volume_type_id: volume_type_id
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- encryption_id: encryption_id
|
- encryption_id: encryption_id
|
||||||
- encryption: encryption
|
- encryption: encryption
|
||||||
- key_size: key_size
|
- key_size: key_size
|
||||||
|
@ -13,7 +13,7 @@ storage object associated with it.
|
|||||||
Extend volume size
|
Extend volume size
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Extends the size of a volume to a requested size, in gibibytes (GiB). Specify the ``os-extend`` action in the request body.
|
Extends the size of a volume to a requested size, in gibibytes (GiB). Specify the ``os-extend`` action in the request body.
|
||||||
|
|
||||||
@ -42,7 +42,7 @@ Request
|
|||||||
|
|
||||||
- os-extend: os-extend
|
- os-extend: os-extend
|
||||||
- new_size: new_size
|
- new_size: new_size
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -60,7 +60,7 @@ Request Example
|
|||||||
Reset volume statuses
|
Reset volume statuses
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Administrator only. Resets the status, attach status, and migration status for a volume. Specify the ``os-reset_status`` action in the request body.
|
Administrator only. Resets the status, attach status, and migration status for a volume. Specify the ``os-reset_status`` action in the request body.
|
||||||
|
|
||||||
@ -76,7 +76,7 @@ Request
|
|||||||
- migration_status: migration_status
|
- migration_status: migration_status
|
||||||
- os-reset_status: os-reset_status
|
- os-reset_status: os-reset_status
|
||||||
- attach_status: attach_status
|
- attach_status: attach_status
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -89,7 +89,7 @@ Request Example
|
|||||||
Set image metadata for volume
|
Set image metadata for volume
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body.
|
Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body.
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ Request
|
|||||||
|
|
||||||
- os-set_image_metadata: os-set_image_metadata
|
- os-set_image_metadata: os-set_image_metadata
|
||||||
- metadata: metadata
|
- metadata: metadata
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -116,7 +116,7 @@ Request Example
|
|||||||
Remove image metadata from volume
|
Remove image metadata from volume
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove.
|
Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove.
|
||||||
|
|
||||||
@ -130,7 +130,7 @@ Request
|
|||||||
|
|
||||||
- os-unset_image_metadata: os-unset_image_metadata
|
- os-unset_image_metadata: os-unset_image_metadata
|
||||||
- key: key
|
- key: key
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -188,7 +188,7 @@ Response Example
|
|||||||
Attach volume to server
|
Attach volume to server
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Attaches a volume to a server. Specify the ``os-attach`` action in the request body.
|
Attaches a volume to a server. Specify the ``os-attach`` action in the request body.
|
||||||
|
|
||||||
@ -210,7 +210,7 @@ Request
|
|||||||
- mountpoint: mountpoint
|
- mountpoint: mountpoint
|
||||||
- host_name: host_name
|
- host_name: host_name
|
||||||
- os-attach: os-attach
|
- os-attach: os-attach
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -223,7 +223,7 @@ Request Example
|
|||||||
Detach volume from a server
|
Detach volume from a server
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Detaches a volume from a server. Specify the ``os-detach`` action in the request body.
|
Detaches a volume from a server. Specify the ``os-detach`` action in the request body.
|
||||||
|
|
||||||
@ -241,7 +241,7 @@ Request
|
|||||||
|
|
||||||
- attachment_id: attachment_id
|
- attachment_id: attachment_id
|
||||||
- os-detach: os-detach
|
- os-detach: os-detach
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -262,7 +262,7 @@ Request Example
|
|||||||
Unmanage volume
|
Unmanage volume
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Removes a volume from Block Storage management without removing the back-end storage object that is associated with it. Specify the ``os-unmanage`` action in the request body.
|
Removes a volume from Block Storage management without removing the back-end storage object that is associated with it. Specify the ``os-unmanage`` action in the request body.
|
||||||
|
|
||||||
@ -279,7 +279,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- os-unmanage: os-unmanage
|
- os-unmanage: os-unmanage
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -297,7 +297,7 @@ Request Example
|
|||||||
Force detach volume
|
Force detach volume
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Forces a volume to detach. Specify the ``os-force_detach`` action in the request body.
|
Forces a volume to detach. Specify the ``os-force_detach`` action in the request body.
|
||||||
|
|
||||||
@ -315,7 +315,7 @@ Request
|
|||||||
- connector: connector
|
- connector: connector
|
||||||
- attachment_id: attachment_id
|
- attachment_id: attachment_id
|
||||||
- os-force_detach: os-force_detach
|
- os-force_detach: os-force_detach
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -371,9 +371,9 @@ Request Example
|
|||||||
|
|
||||||
|
|
||||||
Force delete volume
|
Force delete volume
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Attempts force-delete of volume, regardless of state. Specify the ``os-force_delete`` action
|
Attempts force-delete of volume, regardless of state. Specify the ``os-force_delete`` action
|
||||||
in the request body.
|
in the request body.
|
||||||
@ -388,7 +388,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- os-force_delete: os-force_delete
|
- os-force_delete: os-force_delete
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -406,7 +406,7 @@ Request Example
|
|||||||
Update volume bootable status
|
Update volume bootable status
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/action
|
||||||
|
|
||||||
Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body.
|
Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body.
|
||||||
|
|
||||||
@ -418,7 +418,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
- os-set_bootable: os-set_bootable
|
- os-set_bootable: os-set_bootable
|
||||||
- bootable: bootable
|
- bootable: bootable
|
||||||
|
@ -62,9 +62,9 @@ status values are:
|
|||||||
List volumes with details
|
List volumes with details
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/volumes/detail
|
.. rest_method:: GET /v2/{project_id}/volumes/detail
|
||||||
|
|
||||||
Lists all Block Storage volumes, with details, that the tenant can access.
|
Lists all Block Storage volumes, with details, that the project can access.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -75,7 +75,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@ -130,7 +130,7 @@ Response Example
|
|||||||
Create volume
|
Create volume
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes
|
.. rest_method:: POST /v2/{project_id}/volumes
|
||||||
|
|
||||||
Creates a volume.
|
Creates a volume.
|
||||||
|
|
||||||
@ -185,7 +185,7 @@ Request
|
|||||||
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints
|
- OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints
|
||||||
- source_replica: source_replica
|
- source_replica: source_replica
|
||||||
- metadata: metadata_2
|
- metadata: metadata_2
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -232,9 +232,9 @@ Response Example
|
|||||||
List volumes
|
List volumes
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/volumes
|
.. rest_method:: GET /v2/{project_id}/volumes
|
||||||
|
|
||||||
Lists summary information for all Block Storage volumes that the tenant can access.
|
Lists summary information for all Block Storage volumes that the project can access.
|
||||||
|
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
@ -245,7 +245,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- sort: sort
|
- sort: sort
|
||||||
- limit: limit
|
- limit: limit
|
||||||
- offset: offset
|
- offset: offset
|
||||||
@ -276,7 +276,7 @@ Response Example
|
|||||||
Show volume details
|
Show volume details
|
||||||
~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/volumes/{volume_id}
|
.. rest_method:: GET /v2/{project_id}/volumes/{volume_id}
|
||||||
|
|
||||||
Shows details for a volume.
|
Shows details for a volume.
|
||||||
|
|
||||||
@ -293,7 +293,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
|
|
||||||
@ -345,7 +345,7 @@ Response Example
|
|||||||
Update volume
|
Update volume
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/volumes/{volume_id}
|
.. rest_method:: PUT /v2/{project_id}/volumes/{volume_id}
|
||||||
|
|
||||||
Updates a volume.
|
Updates a volume.
|
||||||
|
|
||||||
@ -362,7 +362,7 @@ Request
|
|||||||
- description: description
|
- description: description
|
||||||
- name: name
|
- name: name
|
||||||
- metadata: metadata_2
|
- metadata: metadata_2
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -415,7 +415,7 @@ Response Example
|
|||||||
Delete volume
|
Delete volume
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/volumes/{volume_id}
|
.. rest_method:: DELETE /v2/{project_id}/volumes/{volume_id}
|
||||||
|
|
||||||
Deletes a volume.
|
Deletes a volume.
|
||||||
|
|
||||||
@ -452,7 +452,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
- cascade: cascade
|
- cascade: cascade
|
||||||
|
|
||||||
@ -464,7 +464,7 @@ Request
|
|||||||
Create volume metadata
|
Create volume metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/metadata
|
.. rest_method:: POST /v2/{project_id}/volumes/{volume_id}/metadata
|
||||||
|
|
||||||
Creates or replaces metadata for a volume. Does not modify items that are not
|
Creates or replaces metadata for a volume. Does not modify items that are not
|
||||||
in the request.
|
in the request.
|
||||||
@ -478,7 +478,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- metadata: metadata_3
|
- metadata: metadata_3
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -508,7 +508,7 @@ Response Example
|
|||||||
Show volume metadata
|
Show volume metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/volumes/{volume_id}/metadata
|
.. rest_method:: GET /v2/{project_id}/volumes/{volume_id}/metadata
|
||||||
|
|
||||||
Shows metadata for a volume.
|
Shows metadata for a volume.
|
||||||
|
|
||||||
@ -521,7 +521,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
|
|
||||||
@ -546,7 +546,7 @@ Response Example
|
|||||||
Update volume metadata
|
Update volume metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{tenant_id}/volumes/{volume_id}/metadata
|
.. rest_method:: PUT /v2/{project_id}/volumes/{volume_id}/metadata
|
||||||
|
|
||||||
Replaces all the volume's metadata with the key-value pairs in the request.
|
Replaces all the volume's metadata with the key-value pairs in the request.
|
||||||
|
|
||||||
@ -560,7 +560,7 @@ Request
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- metadata: metadata_3
|
- metadata: metadata_3
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
@ -591,7 +591,7 @@ Response Example
|
|||||||
Show volume metadata for a specific key
|
Show volume metadata for a specific key
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: GET /v2/{tenant_id}/volumes/{volume_id}/metadata/{key}
|
.. rest_method:: GET /v2/{project_id}/volumes/{volume_id}/metadata/{key}
|
||||||
|
|
||||||
Shows metadata for a volume for a specific key.
|
Shows metadata for a volume for a specific key.
|
||||||
|
|
||||||
@ -603,7 +603,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
- key: key_2
|
- key: key_2
|
||||||
|
|
||||||
@ -629,7 +629,7 @@ Response Example
|
|||||||
Delete volume metadata
|
Delete volume metadata
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: DELETE /v2/{tenant_id}/volumes/{volume_id}/metadata/{key}
|
.. rest_method:: DELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key}
|
||||||
|
|
||||||
Deletes metadata for a volume.
|
Deletes metadata for a volume.
|
||||||
|
|
||||||
@ -641,7 +641,7 @@ Request
|
|||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- tenant_id: tenant_id
|
- project_id: project_id_path
|
||||||
- volume_id: volume_id_path
|
- volume_id: volume_id_path
|
||||||
- key: key_1
|
- key: key_1
|
||||||
|
|
||||||
@ -649,7 +649,7 @@ Request
|
|||||||
|
|
||||||
|
|
||||||
Update volume metadata for a specific key
|
Update volume metadata for a specific key
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. rest_method:: PUT /v2/{project_id}/volumes/{volume_id}/metadata/{key}
|
.. rest_method:: PUT /v2/{project_id}/volumes/{volume_id}/metadata/{key}
|
||||||
|
|
||||||
|
@ -133,7 +133,7 @@ quota_class_name:
|
|||||||
type: string
|
type: string
|
||||||
quotas_project_id:
|
quotas_project_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the tenant in a multi-tenancy cloud.
|
The UUID of the project in a multi-tenancy cloud.
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
@ -196,7 +196,7 @@ action:
|
|||||||
type: string
|
type: string
|
||||||
all-tenants:
|
all-tenants:
|
||||||
description: |
|
description: |
|
||||||
Shows details for all project. Admin only..
|
Shows details for all project. Admin only.
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
@ -1944,7 +1944,7 @@ os-vol-mig-status-attr:name_id:
|
|||||||
type: string
|
type: string
|
||||||
os-vol-tenant-attr:tenant_id:
|
os-vol-tenant-attr:tenant_id:
|
||||||
description: |
|
description: |
|
||||||
The tenant ID which the volume belongs to.
|
The project ID which the volume belongs to.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
|
@ -56,7 +56,7 @@ Update quota classes for a project
|
|||||||
|
|
||||||
.. rest_method:: PUT /v3/{admin_project_id}/os-quota-class-sets/{quota_class_name}
|
.. rest_method:: PUT /v3/{admin_project_id}/os-quota-class-sets/{quota_class_name}
|
||||||
|
|
||||||
Updates quota class set for a tenant. If the ``quota_class_name`` key does not
|
Updates quota class set for a project. If the ``quota_class_name`` key does not
|
||||||
exist, then the API will create one.
|
exist, then the API will create one.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"cores": 20,
|
"cores": 20,
|
||||||
"fixed_ips": -1,
|
"fixed_ips": -1,
|
||||||
"floating_ips": 10,
|
"floating_ips": 10,
|
||||||
"id": "fake_tenant",
|
"id": "fake_project",
|
||||||
"injected_file_content_bytes": 10240,
|
"injected_file_content_bytes": 10240,
|
||||||
"injected_file_path_bytes": 255,
|
"injected_file_path_bytes": 255,
|
||||||
"injected_files": 5,
|
"injected_files": 5,
|
||||||
|
Loading…
Reference in New Issue
Block a user