File: usages.inc

package info (click to toggle)
placement 14.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,380 kB
  • sloc: python: 17,629; sh: 310; makefile: 61; pascal: 30
file content (59 lines) | stat: -rw-r--r-- 1,423 bytes parent folder | download | duplicates (3)
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
======
Usages
======

Represent the consumption of resources for a project and user.

.. note:: Usages API requests are available starting from version 1.9.

List usages
===========

Return a report of usage information for resources associated with the
project identified by `project_id` and user identified by
`user_id`. The value is a dictionary of resource classes paired with
the sum of the allocations of that resource class for provided
parameters.

.. rest_method:: GET /usages

Normal Response Codes: 200

Error response codes: badRequest(400)

Request
-------

.. rest_parameters:: parameters.yaml

  - project_id: project_id
  - user_id: user_id
  - consumer_type: consumer_type_req

Response (microversions 1.38 - )
--------------------------------

.. rest_parameters:: parameters.yaml

  - usages.consumer_type: consumer_type
  - usages.consumer_type.consumer_count: consumer_count
  - usages.consumer_type.RESOURCE_CLASS: resources_single

Response Example (microversions 1.38 - )
----------------------------------------

.. literalinclude:: ./samples/usages/get-usages-1.38.json
   :language: javascript

Response (microversions 1.9 - 1.36)
-----------------------------------

.. rest_parameters:: parameters.yaml

  - usages: resources

Response Example (microversions 1.9 - 1.36)
-------------------------------------------

.. literalinclude:: ./samples/usages/get-usages.json
   :language: javascript