1f120b5649
This includes project id verification for flavor access calls. Closes-Bug: #1544989 Implements bp:validate-project-with-keystone Change-Id: I2620c3ebc2a6dc131946602f8aa36ec0b6e782e0
137 lines
3.5 KiB
ReStructuredText
137 lines
3.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
============================================
|
|
Flavors access (flavors, os-flavor-access)
|
|
============================================
|
|
|
|
Lists tenants who have access to a private flavor and adds private
|
|
flavor access to and removes private flavor access from tenants. By
|
|
default, only administrators can manage private flavor access. A private
|
|
flavor has ``is_public`` set to ``false`` while a public flavor has
|
|
``is_public`` set to ``true``.
|
|
|
|
List Flavor Access Information For Given Flavor
|
|
===============================================
|
|
|
|
.. rest_method:: GET /flavors/{flavor_id}/os-flavor-access
|
|
|
|
Lists flavor access information.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- flavor_access: flavor_access
|
|
- tenant_id: tenant_id_body
|
|
- flavor_id: flavor_id_body
|
|
|
|
**Example List Flavor Access Information For Given Flavor: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-list-resp.json
|
|
:language: javascript
|
|
|
|
Add Flavor Access To Tenant (addTenantAccess Action)
|
|
====================================================
|
|
|
|
.. rest_method:: POST /flavors/{flavor_id}/action
|
|
|
|
Adds flavor access to a tenant and flavor.
|
|
|
|
Specify the ``addTenantAccess`` action and the ``tenant`` in the request body.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), conflict(409)
|
|
|
|
- 400 - BadRequest - if the `tenant` is not found in your OpenStack
|
|
deployment, a 400 is returned to prevent typos on the API call.
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- addTenantAccess: addTenantAccess
|
|
- tenant: tenant_id_body
|
|
|
|
**Example Add Flavor Access To Tenant: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-add-tenant-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- flavor_access: flavor_access
|
|
- tenant_id: tenant_id_body
|
|
- flavor_id: flavor_id_body
|
|
|
|
**Example Add Flavor Access To Tenant: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-add-tenant-resp.json
|
|
:language: javascript
|
|
|
|
Remove Flavor Access From Tenant (removeTenantAccess Action)
|
|
============================================================
|
|
|
|
.. rest_method:: POST /flavors/{flavor_id}/action
|
|
|
|
Removes flavor access from a tenant and flavor.
|
|
|
|
Specify the ``removeTenantAccess`` action and the ``tenant`` in the request body.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), conflict(409)
|
|
|
|
- 400 - BadRequest - if the `tenant` is not found in your OpenStack
|
|
deployment, a 400 is returned to prevent typos on the API call.
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- removeTenantAccess: removeTenantAccess
|
|
- tenant: tenant_id_body
|
|
|
|
**Example Remove Flavor Access From Tenant: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-remove-tenant-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- flavor_access: flavor_access
|
|
- tenant_id: tenant_id_body
|
|
- flavor_id: flavor_id_body
|
|
|
|
**Example Remove Flavor Access From Tenant: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-remove-tenant-resp.json
|
|
:language: javascript
|