diff --git a/api-ref/source/v3/capabilities-v3.inc b/api-ref/source/v3/capabilities-v3.inc index bb2fed37700..ee7991a7edc 100644 --- a/api-ref/source/v3/capabilities-v3.inc +++ b/api-ref/source/v3/capabilities-v3.inc @@ -10,7 +10,7 @@ Shows capabilities for a storage back end. Show all back-end capabilities ============================== -.. rest_method:: GET /v3/{tenant_id}/capabilities/{hostname} +.. rest_method:: GET /v3/{project_id}/capabilities/{hostname} Shows capabilities for a storage back end on the host. The ``hostname`` takes the form of ``hostname@volume_backend_name``. @@ -23,7 +23,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - hostname: hostname Response Parameters diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index caec870a4c5..3edcd4c1904 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -15,10 +15,10 @@ Use the ``policy.json`` file to grant permissions for these actions to limit roles. -List tenant's consistency groups -================================ +List project's consistency groups +================================= -.. rest_method:: GET /v3/{tenant_id}/consistencygroups +.. rest_method:: GET /v3/{project_id}/consistencygroups Lists consistency groups. @@ -32,7 +32,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -57,7 +57,7 @@ Response Example Create a consistency group ========================== -.. rest_method:: POST /v3/{tenant_id}/consistencygroups +.. rest_method:: POST /v3/{project_id}/consistencygroups Creates a consistency group. @@ -69,7 +69,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - description: description_6 - availability_zone: availability_zone - volume_types: volume_types_2 @@ -103,7 +103,7 @@ Response Example Show a consistency group's details ================================== -.. rest_method:: GET /v3/{tenant_id}/consistencygroups/{consistencygroup_id} +.. rest_method:: GET /v3/{project_id}/consistencygroups/{consistencygroup_id} Shows details for a consistency group. @@ -115,7 +115,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - consistencygroup_id: consistencygroup_id Response Parameters @@ -141,7 +141,7 @@ Response Example Create a consistency group from source ====================================== -.. rest_method:: POST /v3/{tenant_id}/consistencygroups/create_from_src +.. rest_method:: POST /v3/{project_id}/consistencygroups/create_from_src Creates a consistency group from source. @@ -160,7 +160,7 @@ Request - source_cgid: source_cgid - project_id: project_id - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -172,7 +172,7 @@ Request Example Delete a consistency group ========================== -.. rest_method:: POST /v3/{tenant_id}/consistencygroups/{consistencygroup_id}/delete +.. rest_method:: POST /v3/{project_id}/consistencygroups/{consistencygroup_id}/delete Deletes a consistency group. @@ -185,7 +185,7 @@ Request .. rest_parameters:: parameters.yaml - force: force - - tenant_id: tenant_id + - project_id: project_id_path - consistencygroup_id: consistencygroup_id Request Example @@ -198,7 +198,7 @@ Request Example List consistency groups and details =================================== -.. rest_method:: GET /v3/{tenant_id}/consistencygroups/detail +.. rest_method:: GET /v3/{project_id}/consistencygroups/detail Lists consistency groups with details. @@ -212,7 +212,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -242,7 +242,7 @@ Response Example Update a consistency group ========================== -.. rest_method:: PUT /v3/{tenant_id}/consistencygroups/{consistencygroup_id}/update +.. rest_method:: PUT /v3/{project_id}/consistencygroups/{consistencygroup_id}/update Updates a consistency group. @@ -258,7 +258,7 @@ Request - description: description - add_volumes: add_volumes - name: name - - tenant_id: tenant_id + - project_id: project_id_path - consistencygroup_id: consistencygroup_id Request Example diff --git a/api-ref/source/v3/ext-backups-actions-v3.inc b/api-ref/source/v3/ext-backups-actions-v3.inc index 08de5f68199..52164a8fefb 100644 --- a/api-ref/source/v3/ext-backups-actions-v3.inc +++ b/api-ref/source/v3/ext-backups-actions-v3.inc @@ -10,7 +10,7 @@ Force-deletes a backup. Force-delete a backup ===================== -.. rest_method:: POST /v3/{tenant_id}/backups/{backup_id}/action +.. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action Force-deletes a backup. Specify the ``os-force_delete`` action in the request body. @@ -28,7 +28,7 @@ Request .. rest_parameters:: parameters.yaml - os-force_delete: os-force_delete - - tenant_id: tenant_id + - project_id: project_id_path - backup_id: backup_id Request Example diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index ee77bcd9a5f..efc488f9784 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -41,9 +41,9 @@ in the ``fail_reason`` field for the backup. List backups with detail ======================== -.. rest_method:: GET /v3/{tenant_id}/backups/detail +.. rest_method:: GET /v3/{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 @@ -55,7 +55,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -94,7 +94,7 @@ Response Example Show backup detail ================== -.. rest_method:: GET /v3/{tenant_id}/backups/{backup_id} +.. rest_method:: GET /v3/{project_id}/backups/{backup_id} Shows details for a backup. @@ -108,7 +108,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - backup_id: backup_id @@ -144,7 +144,7 @@ Response Example Delete a backup =============== -.. rest_method:: DELETE /v3/{tenant_id}/backups/{backup_id} +.. rest_method:: DELETE /v3/{project_id}/backups/{backup_id} Deletes a backup. @@ -155,14 +155,14 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - backup_id: backup_id Restore a backup ================ -.. rest_method:: POST /v3/{tenant_id}/backups/{backup_id}/restore +.. rest_method:: POST /v3/{project_id}/backups/{backup_id}/restore Restores a Block Storage backup to an existing or new Block Storage volume. @@ -180,7 +180,7 @@ Request - restore: restore - name: name - volume_id: volume_id - - tenant_id: tenant_id + - project_id: project_id_path - backup_id: backup_id Request Example @@ -201,7 +201,7 @@ Response Parameters Create a backup =============== -.. rest_method:: POST /v3/{tenant_id}/backups +.. rest_method:: POST /v3/{project_id}/backups Creates a Block Storage backup from a volume. @@ -219,7 +219,7 @@ Request - force: force - backup: backup - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -237,12 +237,12 @@ Response Parameters - links: links - name: name -List backups for tenant -======================= +List backups for project +======================== -.. rest_method:: GET /v3/{tenant_id}/backups +.. rest_method:: GET /v3/{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 Error response codes: @@ -252,7 +252,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 13318c10926..797d84fbc0a 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -11,7 +11,7 @@ deletes group snapshots. Delete group snapshot ===================== -.. rest_method:: DELETE /v3/{tenant_id}/group_snapshots/{group_snapshot_id} +.. rest_method:: DELETE /v3/{project_id}/group_snapshots/{group_snapshot_id} Deletes a group snapshot. @@ -24,14 +24,14 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - group_snapshot_id: group_snapshot_id Show group snapshot details =========================== -.. rest_method:: GET /v3/{tenant_id}/group_snapshots/{group_snapshot_id} +.. rest_method:: GET /v3/{project_id}/group_snapshots/{group_snapshot_id} Shows details for a group snapshot. @@ -45,7 +45,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - group_snapshot_id: group_snapshot_id @@ -71,7 +71,7 @@ Response Example List group snapshots with details ================================= -.. rest_method:: GET /v3/{tenant_id}/group_snapshots/detail +.. rest_method:: GET /v3/{project_id}/group_snapshots/detail Lists all group snapshots with details. @@ -84,7 +84,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -108,7 +108,7 @@ Response Example List group snapshots ==================== -.. rest_method:: GET /v3/{tenant_id}/group_snapshots +.. rest_method:: GET /v3/{project_id}/group_snapshots Lists all group snapshots. @@ -122,7 +122,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -144,7 +144,7 @@ Response Example Create group snapshot ===================== -.. rest_method:: POST /v3/{tenant_id}/group_snapshots +.. rest_method:: POST /v3/{project_id}/group_snapshots Creates a group snapshot. @@ -160,7 +160,7 @@ Request - name: name - description: description - group_id: group_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc index 6e95c0cf311..9c0b2ba6a31 100644 --- a/api-ref/source/v3/group-types.inc +++ b/api-ref/source/v3/group-types.inc @@ -8,7 +8,7 @@ Group types Update group type ================= -.. rest_method:: PUT /v3/{tenant_id}/group_types/{group_type_id} +.. rest_method:: PUT /v3/{project_id}/group_types/{group_type_id} Updates a group type. @@ -26,7 +26,7 @@ Request - group_type: group_type - group_type_id: group_type_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -56,7 +56,7 @@ Response Example Create group specs for a group type =================================== -.. rest_method:: POST /v3/{tenant_id}/group_types/{group_type_id}/group_specs +.. rest_method:: POST /v3/{project_id}/group_types/{group_type_id}/group_specs Create group specs for a group type. @@ -73,7 +73,7 @@ Request - group_specs: group_specs - group_type: group_type - group_type_id: group_type_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -105,7 +105,7 @@ Response Example Show group type details ======================= -.. rest_method:: GET /v3/{tenant_id}/group_types/{group_type_id} +.. rest_method:: GET /v3/{project_id}/group_types/{group_type_id} Shows details for a group type. @@ -119,7 +119,7 @@ Request .. rest_parameters:: parameters.yaml - group_type_id: group_type_id - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -144,7 +144,7 @@ Response Example Delete group type ================= -.. rest_method:: DELETE /v3/{tenant_id}/group_types/{group_type_id} +.. rest_method:: DELETE /v3/{project_id}/group_types/{group_type_id} Deletes a group type. @@ -158,13 +158,13 @@ Request .. rest_parameters:: parameters.yaml - group_type_id: group_type_id - - tenant_id: tenant_id + - project_id: project_id_path List group types ================ -.. rest_method:: GET /v3/{tenant_id}/group_types +.. rest_method:: GET /v3/{project_id}/group_types Lists group types. @@ -178,7 +178,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -205,7 +205,7 @@ Response Example Create group type ================= -.. rest_method:: POST /v2/{tenant_id}/group_types +.. rest_method:: POST /v3/{project_id}/group_types Creates a group type. @@ -223,7 +223,7 @@ Request .. rest_parameters:: parameters.yaml - group_type: group_type - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index abbdebd2b13..8935d67ea35 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -9,7 +9,7 @@ manage them together. How is generic volume groups different from consistency groups? Currently consistency groups in cinder only support consistent group -snapshot. It cannot be extended easily to serve other purposes. A tenant +snapshot. It cannot be extended easily to serve other purposes. A project may want to put volumes used in the same application together in a group so that it is easier to manage them together, and this group of volumes may or may not support consistent group snapshot. Generic volume group @@ -21,7 +21,7 @@ groups can be extended to support other features in the future. List groups =========== -.. rest_method:: GET /v3/{tenant_id}/groups +.. rest_method:: GET /v3/{project_id}/groups Lists groups. @@ -35,7 +35,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -60,7 +60,7 @@ Response Example Create group ============ -.. rest_method:: POST /v3/{tenant_id}/groups +.. rest_method:: POST /v3/{project_id}/groups Creates a group. @@ -78,7 +78,7 @@ Request - group_type: group_type - volume_types: volume_types - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -90,7 +90,7 @@ Request Example Show group details ================== -.. rest_method:: GET /v3/{tenant_id}/groups/{group_id} +.. rest_method:: GET /v3/{project_id}/groups/{group_id} Shows details for a group. @@ -102,7 +102,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - group_id: group_id Response Parameters @@ -129,7 +129,7 @@ Response Example Create group from source ======================== -.. rest_method:: POST /v3/{tenant_id}/groups/action +.. rest_method:: POST /v3/{project_id}/groups/action Creates a group from source. @@ -146,7 +146,7 @@ Request - group_snapshot_id: group_snapshot_id - source_group_id: source_group_id - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -158,7 +158,7 @@ Request Example Delete group ============ -.. rest_method:: POST /v3/{tenant_id}/groups/{group_id}/action +.. rest_method:: POST /v3/{project_id}/groups/{group_id}/action Deletes a group. @@ -172,7 +172,7 @@ Request .. rest_parameters:: parameters.yaml - delete-volumes: delete-volumes - - tenant_id: tenant_id + - project_id: project_id_path - group_id: group_id Request Example @@ -185,7 +185,7 @@ Request Example List groups with details ======================== -.. rest_method:: GET /v3/{tenant_id}/groups/detail +.. rest_method:: GET /v3/{project_id}/groups/detail Lists groups with details. @@ -199,7 +199,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -230,7 +230,7 @@ Response Example Update group ============ -.. rest_method:: PUT /v3/{tenant_id}/groups/{group_id} +.. rest_method:: PUT /v3/{project_id}/groups/{group_id} Updates a group. @@ -247,7 +247,7 @@ Request - description: description - add_volumes: add_volumes - name: name - - tenant_id: tenant_id + - project_id: project_id_path - group_id: group_id Request Example diff --git a/api-ref/source/v3/limits.inc b/api-ref/source/v3/limits.inc index 2d7cba04870..325b4eaa502 100644 --- a/api-ref/source/v3/limits.inc +++ b/api-ref/source/v3/limits.inc @@ -4,18 +4,18 @@ 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 for the item is infinite. -Show absolute limits for tenant -=============================== +Show absolute limits for project +================================ -.. rest_method:: GET /v3/{tenant_id}/limits +.. rest_method:: GET /v3/{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 for the item is infinite. @@ -29,7 +29,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters ------------------- diff --git a/api-ref/source/v3/os-cgsnapshots-v3.inc b/api-ref/source/v3/os-cgsnapshots-v3.inc index 2a97f4949f5..6b86ec7ae6c 100644 --- a/api-ref/source/v3/os-cgsnapshots-v3.inc +++ b/api-ref/source/v3/os-cgsnapshots-v3.inc @@ -11,7 +11,7 @@ deletes consistency group snapshots. Delete a consistency group snapshot =================================== -.. rest_method:: DELETE /v3/{tenant_id}/cgsnapshots/{cgsnapshot_id} +.. rest_method:: DELETE /v3/{project_id}/cgsnapshots/{cgsnapshot_id} Deletes a consistency group snapshot. @@ -23,14 +23,14 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - cgsnapshot_id: cgsnapshot_id Show consistency group snapshot detail ====================================== -.. rest_method:: GET /v3/{tenant_id}/cgsnapshots/{cgsnapshot_id} +.. rest_method:: GET /v3/{project_id}/cgsnapshots/{cgsnapshot_id} Shows details for a consistency group snapshot. @@ -44,7 +44,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - cgsnapshot_id: cgsnapshot_id @@ -70,7 +70,7 @@ Response Example List all consistency group snapshots with details ================================================= -.. rest_method:: GET /v3/{tenant_id}/cgsnapshots/detail +.. rest_method:: GET /v3/{project_id}/cgsnapshots/detail Lists all consistency group snapshots with details. @@ -83,7 +83,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -107,7 +107,7 @@ Response Example List all consistency group snapshots ==================================== -.. rest_method:: GET /v3/{tenant_id}/cgsnapshots +.. rest_method:: GET /v3/{project_id}/cgsnapshots Lists all consistency group snapshots. @@ -121,7 +121,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -146,7 +146,7 @@ Response Example Create a consistency group snapshot =================================== -.. rest_method:: POST /v3/{tenant_id}/cgsnapshots +.. rest_method:: POST /v3/{project_id}/cgsnapshots Creates a consistency group snapshot. @@ -158,7 +158,7 @@ Request .. rest_parameters:: parameters.yaml - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- diff --git a/api-ref/source/v3/os-vol-image-meta-v3.inc b/api-ref/source/v3/os-vol-image-meta-v3.inc index 48181bc2b5a..c9a3dd63403 100644 --- a/api-ref/source/v3/os-vol-image-meta-v3.inc +++ b/api-ref/source/v3/os-vol-image-meta-v3.inc @@ -10,7 +10,7 @@ Shows image metadata that is associated with a volume. Show image metadata for a volume ================================ -.. rest_method:: GET /v3/{tenant_id}/os-vol-image-meta +.. rest_method:: GET /v3/{project_id}/os-vol-image-meta Shows image metadata for a volume. @@ -37,7 +37,7 @@ Request - host: host - ref: ref - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- diff --git a/api-ref/source/v3/os-vol-pool-v3.inc b/api-ref/source/v3/os-vol-pool-v3.inc index 20d4704a7d3..e1c02a8a0c6 100644 --- a/api-ref/source/v3/os-vol-pool-v3.inc +++ b/api-ref/source/v3/os-vol-pool-v3.inc @@ -11,7 +11,7 @@ to the scheduler service. List all back-end storage pools =============================== -.. rest_method:: GET /v3/{tenant_id}/scheduler-stats/get_pools +.. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools Lists all back-end storage pools. @@ -24,7 +24,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - detail: detail Response Parameters diff --git a/api-ref/source/v3/os-vol-transfer-v3.inc b/api-ref/source/v3/os-vol-transfer-v3.inc index ce30a69fd2d..84ffd05519a 100644 --- a/api-ref/source/v3/os-vol-transfer-v3.inc +++ b/api-ref/source/v3/os-vol-transfer-v3.inc @@ -10,7 +10,7 @@ Transfers a volume from one user to another user. Accept a volume transfer ======================== -.. rest_method:: POST /v3/{tenant_id}/os-volume-transfer/{transfer_id}/accept +.. rest_method:: POST /v3/{project_id}/os-volume-transfer/{transfer_id}/accept Accepts a volume transfer. @@ -24,7 +24,7 @@ Request - auth_key: auth_key - transfer_id: transfer_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -48,7 +48,7 @@ Response Parameters Create a volume transfer ======================== -.. rest_method:: POST /v3/{tenant_id}/os-volume-transfer +.. rest_method:: POST /v3/{project_id}/os-volume-transfer Creates a volume transfer. @@ -62,7 +62,7 @@ Request - name: name - volume_id: volume_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -84,10 +84,10 @@ Response Parameters - name: name -List volume transfers for a tenant -================================== +List volume transfers for a project +=================================== -.. rest_method:: GET /v3/{tenant_id}/os-volume-transfer +.. rest_method:: GET /v3/{project_id}/os-volume-transfer Lists volume transfers. @@ -101,7 +101,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -125,7 +125,7 @@ Response Example Show volume transfer detail =========================== -.. rest_method:: GET /v3/{tenant_id}/os-volume-transfer/{transfer_id} +.. rest_method:: GET /v3/{project_id}/os-volume-transfer/{transfer_id} Shows details for a volume transfer. @@ -140,7 +140,7 @@ Request .. rest_parameters:: parameters.yaml - transfer_id: transfer_id - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -165,7 +165,7 @@ Response Example Delete a volume transfer ======================== -.. rest_method:: DELETE /v3/{tenant_id}/os-volume-transfer/{transfer_id} +.. rest_method:: DELETE /v3/{project_id}/os-volume-transfer/{transfer_id} Deletes a volume transfer. @@ -178,13 +178,13 @@ Request .. rest_parameters:: parameters.yaml - transfer_id: transfer_id - - tenant_id: tenant_id + - project_id: project_id_path List volume transfers and details ================================= -.. rest_method:: GET /v3/{tenant_id}/os-volume-transfer/detail +.. rest_method:: GET /v3/{project_id}/os-volume-transfer/detail Lists volume transfers, with details. @@ -197,7 +197,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters ------------------- diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 2511fd43087..13b9b9f4609 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -7,9 +7,9 @@ x-openstack-request-id: type: string # variables in path -admin_tenant_id: +admin_project_id: description: | - The UUID of the administrative tenant. + The UUID of the administrative project. in: path required: false type: string @@ -87,12 +87,6 @@ snapshot_id_1: in: path required: false type: string -tenant_id: - description: | - The UUID of the tenant in a multi-tenancy cloud. - in: path - required: false - type: string transfer_id: description: | The unique identifier for a volume transfer. @@ -134,7 +128,7 @@ action: type: string all-tenants: description: | - Shows details for all tenants. Admin only.. + Shows details for all project. Admin only.. in: query required: false type: string @@ -421,7 +415,7 @@ control_location: cores: description: | The number of instance cores that are allowed for - each tenant. + each project. in: body required: true type: integer @@ -624,7 +618,7 @@ fail_reason: fixed_ips: description: | 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. in: body required: true @@ -632,7 +626,7 @@ fixed_ips: floating_ips: description: | The number of floating IP addresses that are - allowed for each tenant. + allowed for each project. in: body required: true type: integer @@ -810,7 +804,7 @@ injected_file_path_bytes: injected_files: description: | The number of injected files that are allowed for - each tenant. + each project. in: body required: true type: integer @@ -823,7 +817,7 @@ instance_uuid: instances: description: | The number of instances that are allowed for each - tenant. + project. in: body required: true type: integer @@ -1365,7 +1359,7 @@ quota_set: ram: description: | The amount of instance RAM in megabytes that are - allowed for each tenant. + allowed for each project. in: body required: true type: integer @@ -1437,7 +1431,7 @@ security_group_rules: security_groups: description: | The number of security groups that are allowed - for each tenant. + for each project. in: body required: true type: integer diff --git a/api-ref/source/v3/qos-specs-v3-qos-specs.inc b/api-ref/source/v3/qos-specs-v3-qos-specs.inc index 4989f5f8795..7250461bdae 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -14,7 +14,7 @@ specifications. Disassociate a QoS specification from all associations ====================================================== -.. rest_method:: GET /v3/{tenant_id}/qos-specs/{qos_id}/disassociate_all +.. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/disassociate_all Disassociates a QoS specification from all associations. @@ -26,14 +26,14 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id Unset keys in a QoS specification ================================= -.. rest_method:: PUT /v3/{tenant_id}/qos-specs/{qos_id}/delete_keys +.. rest_method:: PUT /v3/{project_id}/qos-specs/{qos_id}/delete_keys Unsets keys in a QoS specification. @@ -48,7 +48,7 @@ Request .. rest_parameters:: parameters.yaml - keys: keys - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id Request Example @@ -69,7 +69,7 @@ Response Example Get all associations for a QoS specification ============================================ -.. rest_method:: GET /v3/{tenant_id}/qos-specs/{qos_id}/associations +.. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/associations Lists all associations for a QoS specification. @@ -83,7 +83,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id @@ -97,7 +97,7 @@ Response Example Associate QoS specification with a volume type ============================================== -.. rest_method:: GET /v3/{tenant_id}/qos-specs/{qos_id}/associate +.. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/associate Associates a QoS specification with a volume type. @@ -109,14 +109,14 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id Disassociate QoS specification from a volume type ================================================= -.. rest_method:: GET /v3/{tenant_id}/qos-specs/{qos_id}/disassociate +.. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/disassociate Disassociates a QoS specification from a volume type. @@ -128,14 +128,14 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id Show a QoS specification details ================================ -.. rest_method:: GET /v3/{tenant_id}/qos-specs/{qos_id} +.. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id} Shows details for a QoS specification. @@ -149,7 +149,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id @@ -176,7 +176,7 @@ Response Example Set keys in a QoS specification =============================== -.. rest_method:: PUT /v3/{tenant_id}/qos-specs/{qos_id} +.. rest_method:: PUT /v3/{project_id}/qos-specs/{qos_id} Sets keys in a QoS specification. @@ -192,7 +192,7 @@ Request - qos_specs: qos_specs - specs: specs - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id Request Example @@ -212,7 +212,7 @@ Response Example Delete a QoS specification ========================== -.. rest_method:: DELETE /v3/{tenant_id}/qos-specs/{qos_id} +.. rest_method:: DELETE /v3/{project_id}/qos-specs/{qos_id} Deletes a QoS specification. @@ -224,7 +224,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - qos_id: qos_id - force: force @@ -232,7 +232,7 @@ Request Create a QoS specification ========================== -.. rest_method:: POST /v3/{tenant_id}/qos-specs +.. rest_method:: POST /v3/{project_id}/qos-specs Creates a QoS specification. @@ -249,7 +249,7 @@ Request - qos_specs: qos_specs - consumer: consumer - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -275,7 +275,7 @@ Response Parameters List QoS Specifications ======================= -.. rest_method:: GET /v3/{tenant_id}/qos-specs +.. rest_method:: GET /v3/{project_id}/qos-specs Lists quality of service (QoS) specifications. @@ -289,7 +289,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit diff --git a/api-ref/source/v3/quota-sets.inc b/api-ref/source/v3/quota-sets.inc index 0b95918db7f..2dc87f9a6ec 100644 --- a/api-ref/source/v3/quota-sets.inc +++ b/api-ref/source/v3/quota-sets.inc @@ -6,15 +6,15 @@ Quota sets extension (os-quota-sets) Administrators only, depending on policy settings. -Shows, updates, and deletes quotas for a tenant. +Shows, updates, and deletes quotas for a project. Show quotas for a user ====================== -.. rest_method:: GET /v3/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} +.. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} -Enables an admin user to show quotas for a tenant and user. +Enables an admin user to show quotas for a project and user. Normal response codes: 200 @@ -25,9 +25,9 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - user_id: user_id - - admin_tenant_id: admin_tenant_id + - admin_project_id: admin_project_id Response Parameters @@ -62,9 +62,9 @@ Response Example Update quotas for a user ======================== -.. rest_method:: PUT /v3/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} +.. rest_method:: PUT /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} -Updates quotas for a tenant and user. +Updates quotas for a project and user. Normal response codes: 200 @@ -92,9 +92,9 @@ Request - fixed_ips: fixed_ips - id: id - security_groups: security_groups - - tenant_id: tenant_id + - project_id: project_id_path - user_id: user_id - - admin_tenant_id: admin_tenant_id + - admin_project_id: admin_project_id Request Example --------------- @@ -133,7 +133,7 @@ Response Example Delete quotas for a user ======================== -.. rest_method:: DELETE /v3/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} +.. rest_method:: DELETE /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} Deletes quotas for a user so that the quotas revert to default values. @@ -147,9 +147,9 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - user_id: user_id - - admin_tenant_id: admin_tenant_id + - admin_project_id: admin_project_id Response Example ---------------- @@ -158,12 +158,12 @@ Response Example :language: javascript -Show quotas for a tenant -======================== +Show quotas for a project +========================= -.. rest_method:: GET /v3/{admin_tenant_id}/os-quota-sets/{tenant_id} +.. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id} -Shows quotas for a tenant. +Shows quotas for a project. Normal response codes: 200 @@ -175,8 +175,8 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - - admin_tenant_id: admin_tenant_id + - project_id: project_id_path + - admin_project_id: admin_project_id - usage: usage @@ -209,12 +209,12 @@ Response Example .. literalinclude:: ./samples/quotas-show-response.json :language: javascript -Update quotas for a tenant -========================== +Update quotas for a project +=========================== -.. rest_method:: PUT /v3/{admin_tenant_id}/os-quota-sets/{tenant_id} +.. rest_method:: PUT /v3/{admin_project_id}/os-quota-sets/{project_id} -Updates quotas for a tenant. +Updates quotas for a project. Normal response codes: 200 @@ -242,8 +242,8 @@ Request - fixed_ips: fixed_ips - id: id - security_groups: security_groups - - tenant_id: tenant_id - - admin_tenant_id: admin_tenant_id + - project_id: project_id_path + - admin_project_id: admin_project_id Request Example --------------- @@ -280,12 +280,12 @@ Response Example .. literalinclude:: ./samples/quotas-update-response.json :language: javascript -Delete quotas for a tenant -========================== +Delete quotas for a project +=========================== -.. rest_method:: DELETE /v3/{admin_tenant_id}/os-quota-sets/{tenant_id} +.. rest_method:: DELETE /v3/{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 @@ -297,8 +297,8 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - - admin_tenant_id: admin_tenant_id + - project_id: project_id_path + - admin_project_id: admin_project_id Response Example ---------------- @@ -309,9 +309,9 @@ Response Example Show quota details for a user ============================= -.. rest_method:: GET /v3/{admin_tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id} +.. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/detail/{user_id} -Shows details for quotas for a tenant and user. +Shows details for quotas for a project and user. Normal response codes: 200 @@ -323,9 +323,9 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - user_id: user_id - - admin_tenant_id: admin_tenant_id + - admin_project_id: admin_project_id Response Parameters @@ -357,12 +357,12 @@ Response Example :language: javascript -Get default quotas for a tenant -=============================== +Get default quotas for a project +================================ -.. rest_method:: GET /v3/{tenant_id}/os-quota-sets/defaults +.. rest_method:: GET /v3/{project_id}/os-quota-sets/defaults -Gets default quotas for a tenant. +Gets default quotas for a project. Normal response codes: 200 @@ -374,7 +374,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters diff --git a/api-ref/source/v3/volume-manage.inc b/api-ref/source/v3/volume-manage.inc index d9d33b2bb86..f91a161a734 100644 --- a/api-ref/source/v3/volume-manage.inc +++ b/api-ref/source/v3/volume-manage.inc @@ -11,7 +11,7 @@ storage. Manage an existing volume ========================= -.. rest_method:: POST /v3/{tenant_id}/os-volume-manage +.. rest_method:: POST /v3/{project_id}/os-volume-manage Creates a Block Storage volume by using existing storage rather than allocating new storage. @@ -46,7 +46,7 @@ Request - cluster: cluster_mutex - ref: ref - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- diff --git a/api-ref/source/v3/volume-type-access.inc b/api-ref/source/v3/volume-type-access.inc index 699c9ad42d2..737459c4fb7 100644 --- a/api-ref/source/v3/volume-type-access.inc +++ b/api-ref/source/v3/volume-type-access.inc @@ -17,7 +17,7 @@ users with the administrative role and context. Add private volume type access to project ========================================= -.. rest_method:: POST /v3/{tenant_id}/types/{volume_type}/action +.. rest_method:: POST /v3/{project_id}/types/{volume_type}/action Adds private volume type access to a project. @@ -30,7 +30,7 @@ Request .. rest_parameters:: parameters.yaml - project: project - - tenant_id: tenant_id + - project_id: project_id_path - volume_type: volume_type Request Example @@ -43,7 +43,7 @@ Request Example Remove private volume type access from project ============================================== -.. rest_method:: POST /v3/{tenant_id}/types/{volume_type}/action +.. rest_method:: POST /v3/{project_id}/types/{volume_type}/action Removes private volume type access from a project. @@ -56,7 +56,7 @@ Request .. rest_parameters:: parameters.yaml - project: project - - tenant_id: tenant_id + - project_id: project_id_path - volume_type: volume_type Request Example @@ -69,7 +69,7 @@ Request Example List private volume type access detail ====================================== -.. rest_method:: GET /v3/{tenant_id}/types/{volume_type}/os-volume-type-access +.. rest_method:: GET /v3/{project_id}/types/{volume_type}/os-volume-type-access Lists project IDs that have access to private volume type. @@ -83,7 +83,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - volume_type: volume_type diff --git a/api-ref/source/v3/volumes-v3-extensions.inc b/api-ref/source/v3/volumes-v3-extensions.inc index 8b7014f63e4..a17fff0254e 100644 --- a/api-ref/source/v3/volumes-v3-extensions.inc +++ b/api-ref/source/v3/volumes-v3-extensions.inc @@ -10,7 +10,7 @@ API extensions (extensions) List Known API extensions ========================= -.. rest_method:: GET /v3/{tenant_id}/extensions +.. rest_method:: GET /v3/{project_id}/extensions Lists Block Storage API extensions. @@ -24,7 +24,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index 15edefa22dd..023c070afeb 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -30,9 +30,9 @@ possible: List snapshots and details ========================== -.. rest_method:: GET /v3/{tenant_id}/snapshots/detail +.. rest_method:: GET /v3/{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 @@ -44,7 +44,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -73,7 +73,7 @@ Response Example Create a snapshot ================= -.. rest_method:: POST /v3/{tenant_id}/snapshots +.. rest_method:: POST /v3/{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. @@ -90,7 +90,7 @@ Request - force: force - description: description - name: name - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -117,9 +117,9 @@ Response Parameters List accessible snapshots ========================= -.. rest_method:: GET /v3/{tenant_id}/snapshots +.. rest_method:: GET /v3/{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 @@ -131,7 +131,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -162,7 +162,7 @@ Response Example Show a snapshot's metadata ========================== -.. rest_method:: GET /v3/{tenant_id}/snapshots/{snapshot_id}/metadata +.. rest_method:: GET /v3/{project_id}/snapshots/{snapshot_id}/metadata Shows metadata for a snapshot. @@ -176,7 +176,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - snapshot_id: snapshot_id @@ -207,7 +207,7 @@ Response Example Update a snapshot's metadata ============================ -.. rest_method:: PUT /v3/{tenant_id}/snapshots/{snapshot_id}/metadata +.. rest_method:: PUT /v3/{project_id}/snapshots/{snapshot_id}/metadata Updates metadata for a snapshot. @@ -225,7 +225,7 @@ Request .. rest_parameters:: parameters.yaml - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path - snapshot_id: snapshot_id Request Example @@ -245,7 +245,7 @@ Response Example Show a snapshot's details ========================= -.. rest_method:: GET /v3/{tenant_id}/snapshots/{snapshot_id} +.. rest_method:: GET /v3/{project_id}/snapshots/{snapshot_id} Shows details for a snapshot. @@ -259,7 +259,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - snapshot_id: snapshot_id @@ -290,7 +290,7 @@ Response Example Update a snapshot ================= -.. rest_method:: PUT /v3/{tenant_id}/snapshots/{snapshot_id} +.. rest_method:: PUT /v3/{project_id}/snapshots/{snapshot_id} Updates a snapshot. @@ -307,7 +307,7 @@ Request - snapshot: snapshot - description: description - name: name - - tenant_id: tenant_id + - project_id: project_id_path - snapshot_id: snapshot_id Request Example @@ -343,7 +343,7 @@ Response Example Delete a snapshot ================= -.. rest_method:: DELETE /v3/{tenant_id}/snapshots/{snapshot_id} +.. rest_method:: DELETE /v3/{project_id}/snapshots/{snapshot_id} Deletes a snapshot. @@ -355,5 +355,5 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - snapshot_id: snapshot_id diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc index ccc7c311f40..d0bca284cb3 100644 --- a/api-ref/source/v3/volumes-v3-types.inc +++ b/api-ref/source/v3/volumes-v3-types.inc @@ -8,7 +8,7 @@ Volume types (types) Update a volume type ==================== -.. rest_method:: PUT /v3/{tenant_id}/types/{volume_type_id} +.. rest_method:: PUT /v3/{project_id}/types/{volume_type_id} Updates a volume type. @@ -37,7 +37,7 @@ Request - volume_type: volume_type - volume_type_id: volume_type_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -68,7 +68,7 @@ Response Example Update extra specs for volume type ================================== -.. rest_method:: PUT /v3/{tenant_id}/types/{volume_type_id} +.. rest_method:: PUT /v3/{project_id}/types/{volume_type_id} Updates the extra specifications that are assigned to a volume type. @@ -85,7 +85,7 @@ Request - extra_specs: extra_specs - volume_type: volume_type - volume_type_id: volume_type_id - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -117,7 +117,7 @@ Response Example Show volume type detail ======================= -.. rest_method:: GET /v3/{tenant_id}/types/{volume_type_id} +.. rest_method:: GET /v3/{project_id}/types/{volume_type_id} Shows details for a volume type. @@ -131,7 +131,7 @@ Request .. rest_parameters:: parameters.yaml - volume_type_id: volume_type_id - - tenant_id: tenant_id + - project_id: project_id_path Response Parameters @@ -156,7 +156,7 @@ Response Example Delete a volume type ==================== -.. rest_method:: DELETE /v3/{tenant_id}/types/{volume_type_id} +.. rest_method:: DELETE /v3/{project_id}/types/{volume_type_id} Deletes a volume type. @@ -169,13 +169,13 @@ Request .. rest_parameters:: parameters.yaml - volume_type_id: volume_type_id - - tenant_id: tenant_id + - project_id: project_id_path List all volume types ===================== -.. rest_method:: GET /v3/{tenant_id}/types +.. rest_method:: GET /v3/{project_id}/types Lists volume types. @@ -189,7 +189,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -216,7 +216,7 @@ Response Example Create a volume type ==================== -.. rest_method:: POST /v3/{tenant_id}/types +.. rest_method:: POST /v3/{project_id}/types Creates a volume type. @@ -244,7 +244,7 @@ Request .. rest_parameters:: parameters.yaml - volume_type: volume_type - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- diff --git a/api-ref/source/v3/volumes-v3-volumes-actions.inc b/api-ref/source/v3/volumes-v3-volumes-actions.inc index 7ad6f31d112..2caea777872 100644 --- a/api-ref/source/v3/volumes-v3-volumes-actions.inc +++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc @@ -14,7 +14,7 @@ storage object associated with it. Extend a volume size ==================== -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{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. @@ -43,7 +43,7 @@ Request - os-extend: os-extend - new_size: new_size - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -61,7 +61,7 @@ Request Example Reset a volume's statuses ========================= -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{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. @@ -77,7 +77,7 @@ Request - migration_status: migration_status - os-reset_status: os-reset_status - attach_status: attach_status - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -95,7 +95,7 @@ Request Example Set image metadata for a volume =============================== -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body. @@ -109,7 +109,7 @@ Request - os-set_image_metadata: os-set_image_metadata - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -127,7 +127,7 @@ Request Example Remove image metadata from a volume =================================== -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{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. @@ -141,7 +141,7 @@ Request - os-unset_image_metadata: os-unset_image_metadata - key: key - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -159,7 +159,7 @@ Request Example Attach volume to a server ========================= -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action Attaches a volume to a server. Specify the ``os-attach`` action in the request body. @@ -181,7 +181,7 @@ Request - mountpoint: mountpoint - host_name: host_name - os-attach: os-attach - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -199,7 +199,7 @@ Request Example Unmanage a volume ================= -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{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. @@ -216,7 +216,7 @@ Request .. rest_parameters:: parameters.yaml - os-unmanage: os-unmanage - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -234,7 +234,7 @@ Request Example Force detach a volume ===================== -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/action +.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action Forces a volume to detach. Specify the ``os-force_detach`` action in the request body. @@ -252,7 +252,7 @@ Request - connector: connector - attachment_id: attachment_id - os-force_detach: os-force_detach - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index b925c403aea..39d1ae6d9c4 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -47,9 +47,9 @@ status values are: List accessbile volumes with details ==================================== -.. rest_method:: GET /v3/{tenant_id}/volumes/detail +.. rest_method:: GET /v3/{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 @@ -61,7 +61,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort: sort - limit: limit - marker: marker @@ -115,7 +115,7 @@ Response Example Create a volume =============== -.. rest_method:: POST /v3/{tenant_id}/volumes +.. rest_method:: POST /v3/{project_id}/volumes Creates a volume. @@ -170,7 +170,7 @@ Request - OS-SCH-HNT:scheduler_hints: OS-SCH-HNT:scheduler_hints - source_replica: source_replica - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path Request Example --------------- @@ -215,9 +215,9 @@ Response Parameters List accessible volumes ======================= -.. rest_method:: GET /v3/{tenant_id}/volumes +.. rest_method:: GET /v3/{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 @@ -229,7 +229,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - sort: sort - limit: limit - marker: marker @@ -259,7 +259,7 @@ Response Example Show a volume's details ======================= -.. rest_method:: GET /v3/{tenant_id}/volumes/{volume_id} +.. rest_method:: GET /v3/{project_id}/volumes/{volume_id} Shows details for a volume. @@ -277,7 +277,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id @@ -329,7 +329,7 @@ Response Example Update a volume =============== -.. rest_method:: PUT /v3/{tenant_id}/volumes/{volume_id} +.. rest_method:: PUT /v3/{project_id}/volumes/{volume_id} Updates a volume. @@ -347,7 +347,7 @@ Request - description: description - name: name - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -400,7 +400,7 @@ Response Example Delete a volume =============== -.. rest_method:: DELETE /v3/{tenant_id}/volumes/{volume_id} +.. rest_method:: DELETE /v3/{project_id}/volumes/{volume_id} Deletes a volume. @@ -437,7 +437,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id @@ -448,7 +448,7 @@ Request Create metadata for volume ========================== -.. rest_method:: POST /v3/{tenant_id}/volumes/{volume_id}/metadata +.. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/metadata Creates metadata for a volume. @@ -461,7 +461,7 @@ Request .. rest_parameters:: parameters.yaml - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example @@ -486,7 +486,7 @@ Response Parameters Show a volume's metadata ======================== -.. rest_method:: GET /v3/{tenant_id}/volumes/{volume_id}/metadata +.. rest_method:: GET /v3/{project_id}/volumes/{volume_id}/metadata Shows metadata for a volume. @@ -500,7 +500,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id @@ -525,7 +525,7 @@ Response Example Update a volume's metadata ========================== -.. rest_method:: PUT /v3/{tenant_id}/volumes/{volume_id}/metadata +.. rest_method:: PUT /v3/{project_id}/volumes/{volume_id}/metadata Updates metadata for a volume. @@ -543,7 +543,7 @@ Request .. rest_parameters:: parameters.yaml - metadata: metadata - - tenant_id: tenant_id + - project_id: project_id_path - volume_id: volume_id Request Example