summaryrefslogtreecommitdiff
path: root/api-ref/source/os-flavor-access.inc
blob: 5d4b21420c117345382b4064841d0ed397ceadaf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.. -*- 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