← Back to branch summary

~libra-core/libra/master

« back to all changes in this revision

Viewing changes to doc/api/rest/limits.rst

  • Committer: Monty Taylor
  • Date: 2015-10-17 20:03:27 UTC
  • Revision ID: git-v1:c7082fa72ac73b23b48ce63fc82aa7da2d3e5d6a
Retire stackforge/libra

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/rest/limits.rst
1
 
.. _api-limits:
2
 
 
3
 
======
4
 
Limits
5
 
======
6
 
 
7
 
 
8
 
Get List of LBaaS API Limits
9
 
----------------------------
10
 
 
11
 
Operation
12
 
~~~~~~~~~~
13
 
 
14
 
+------------+----------------------------+----------+--------------------------+
15
 
| Resource   | Operation                  | Method   | Path                     |
16
 
+============+============================+==========+==========================+
17
 
| Limits     | Get list of LBaaS limits   | GET      | {baseURI}/{ver}/limits   |
18
 
+------------+----------------------------+----------+--------------------------+
19
 
 
20
 
Description
21
 
~~~~~~~~~~~
22
 
 
23
 
This method allows querying the LBaaS service for a list of API limits
24
 
which apply on a tenant basis. Each tenant may not utilize LBaaS API
25
 
resources exceeding these limits and will receive and over limit error
26
 
if attempted (413).
27
 
 
28
 
+-----------------------------+------------------------------------------------------------+
29
 
| Returned Limit Name         | Value                                                      |
30
 
+=============================+============================================================+
31
 
| maxLoadBalancers            | Maximum number of load balancers allowed for this tenant   |
32
 
+-----------------------------+------------------------------------------------------------+
33
 
| maxNodesPerLoadBalancer     | Maximum number of nodes allowed for each load balancer     |
34
 
+-----------------------------+------------------------------------------------------------+
35
 
| maxLoadBalancerNameLength   | Maximum length allowed for a load balancer name            |
36
 
+-----------------------------+------------------------------------------------------------+
37
 
| maxVIPsPerLoadBalancer      | Maximum number of Virtual IPs for each load balancer       |
38
 
+-----------------------------+------------------------------------------------------------+
39
 
 
40
 
Request Data
41
 
~~~~~~~~~~~~
42
 
 
43
 
None required.
44
 
 
45
 
Query Parameters Supported
46
 
~~~~~~~~~~~~~~~~~~~~~~~~~~
47
 
 
48
 
None required.
49
 
 
50
 
Required HTTP Header Values
51
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~
52
 
 
53
 
**X-Auth-Token**
54
 
 
55
 
Request Body
56
 
~~~~~~~~~~~~
57
 
 
58
 
None required.
59
 
 
60
 
Normal Response Code
61
 
~~~~~~~~~~~~~~~~~~~~
62
 
 
63
 
+--------------------+---------------+
64
 
| HTTP Status Code   | Description   |
65
 
+====================+===============+
66
 
| 200                | OK            |
67
 
+--------------------+---------------+
68
 
 
69
 
Response Body
70
 
~~~~~~~~~~~~~
71
 
 
72
 
The response body contains information regarding limits imposed for the
73
 
tenant making the request.
74
 
 
75
 
Error Response Codes
76
 
~~~~~~~~~~~~~~~~~~~~
77
 
 
78
 
+--------------------+----------------+
79
 
| HTTP Status Code   | Description    |
80
 
+====================+================+
81
 
| 400                | Bad Request    |
82
 
+--------------------+----------------+
83
 
| 401                | Unauthorized   |
84
 
+--------------------+----------------+
85
 
| 404                | Not Found      |
86
 
+--------------------+----------------+
87
 
| 405                | Not Allowed    |
88
 
+--------------------+----------------+
89
 
| 500                | LBaaS Fault    |
90
 
+--------------------+----------------+
91
 
 
92
 
Example
93
 
~~~~~~~
94
 
 
95
 
**Curl Request**
96
 
 
97
 
::
98
 
 
99
 
    curl -H "X-Auth-Token: TOKEN" https://uswest.region-b.geo-1.lbaas.hpcloudsvc.com/v1.1/limits
100
 
 
101
 
**Response**
102
 
 
103
 
::
104
 
 
105
 
    {
106
 
    "limits": {
107
 
            "absolute": {
108
 
                    "values": {
109
 
                        "maxLoadBalancerNameLength": 128,
110
 
                        "maxLoadBalancers": 20,
111
 
                        "maxNodesPerLoadBalancer": 5,
112
 
                        "maxVIPsPerLoadBalancer": 1
113
 
                        }
114
 
                }
115
 
            }
116
 
    }
117