Show absolute limits¶

Overview¶

Shows absolute limits for a tenant.

Classification¶

Show

API Operation Object¶

limits

Synchronous / Asynchronous¶

Request¶

HTTP Request Method¶

HTTP Request Path¶

{api_endpoint}/v2/{tenant_id}/limits

HTTP Request Header¶

Format¶

Accept-Encoding: gzip, deflate, compress(optional)
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body¶

Format¶

none

Request Parameter¶

Request Parameters¶
name	style	format	description	required/optional
tenant_id	URI	String	The ID for the tenant or project in a multi-tenancy cloud.	required

Response¶

HTTP Response Header¶

Format¶

HTTP/1.1 <response code> <message>       (ex. 200 OK)

<response_code>: see "HTTP Responses" section
<message>: message based on the response code
- skip auto insert field such as "X-Compute-Request-Id" and "X-Openstack-Request-Id", "Content-Length", "Date"

Response Code¶

Response Codes¶
response code	condition
200, 203	normal end
*	Follow a Common Error Code

HTTP Response Body¶

Format¶

{
    "limits": {
        "rate": [],
        "absolute": {
            "totalSnapshotsUsed": <totalSnapshotsUsed>,
            "maxTotalVolumeGigabytes": <maxTotalVolumeGigabytes>,
            "totalGigabytesUsed": <totalGigabytesUsed>,
            "maxTotalSnapshots": <maxTotalSnapshots>,
            "totalVolumesUsed": <totalVolumesUsed>,
            "maxTotalVolumes": <maxTotalVolumes>
        }
    }
}

Response Parameter¶

Response Parameters¶
item	format	description
limits	String	A limits object.
absolute	String	An absolute limits object.
totalSnapshotsUsed	int	Total number of snapshots used.
maxTotalVolumeGigabytes	int	Maximum total amount of volumes, in gibibytes (GiB).
totalGigabytesUsed	int	Total number of gibibytes (GiB) used.
maxTotalSnapshots	int	Maximum number of snapshots.
totalVolumesUsed	int	Total number of volumes used.
maxTotalVolumes	int	Maximum number of volumes.
maxTotalBackups	int	Maximum number of backups.
maxTotalBackupGigabytes	int	Maximum total amount of backup, in gibibytes (GiB).
totalBackupGigabytesUsed	int	Total number of backupgibibytes (GiB) used.
totalBackupsUsed	int	Total number of backups used.

Sample API Request and Response¶

Sample API Request¶

Request URI¶

https://example.com/v2/{tenant_id}/limits

Request Header¶

Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: ajk3adjiown02

Request Body¶

none

Sample API Response¶

Response Header¶

HTTP/1.1 200 OK

<response_code>: see "HTTP Responses" section
<message>: message based on the response code
- skip auto insert field such as "X-Compute-Request-Id" and "X-Openstack-Request-Id", "Content-Length", "Date"

Response Body¶

{
    "limits": {
        "rate": [],
        "absolute": {
            "totalSnapshotsUsed": 0,
            "maxTotalVolumeGigabytes": 1000,
            "totalGigabytesUsed": 0,
            "maxTotalSnapshots": 10,
            "totalVolumesUsed": 0,
            "maxTotalVolumes": 10
        }
    }
}

Execution Example¶

HTTP Request¶

GET /v2/cb8aa2a2c7244af5aab1fa7881ba7f4c/limits HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:8776
X-Auth-Token: 517486dbd39a44088fdc5b3dfcfdb831
Content-type: application/json
Accept: application/json

HTTP Response¶

HTTP/1.1 200 OK
X-Compute-Request-Id: req-cd5907f0-8139-484b-a057-96dfde7f7078
Content-Type: application/json
Content-Length: 302
X-Openstack-Request-Id: req-cd5907f0-8139-484b-a057-96dfde7f7078
Date: Thu, 15 Oct 2015 12:32:55 GMT

{"limits": {"rate": [], "absolute": {"totalSnapshotsUsed": 0, "maxTotalBackups": 10, "maxTotalVolumeGigabytes": 1000, "maxTotalSnapshots": 10, "maxTotalBackupGigabytes": 1000, "totalBackupGigabytesUsed": 0, "maxTotalVolumes": 10, "totalVolumesUsed": 1, "totalBackupsUsed": 0, "totalGigabytesUsed": 1}}}

Error Execution Example¶

HTTP Request¶

GET /v2/cb8aa2a2c7244af5aab1fa7881ba7f4/limits HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:8776
X-Auth-Token: 517486dbd39a44088fdc5b3dfcfdb831
Content-type: application/json
Accept: application/json

HTTP Response¶

HTTP/1.1 400 Bad Request
Content-Length: 65
Content-Type: application/json; charset=UTF-8
X-Compute-Request-Id: req-02d18c1b-3f96-4693-b54b-91e54e3a289e
X-Openstack-Request-Id: req-02d18c1b-3f96-4693-b54b-91e54e3a289e
Date: Thu, 15 Oct 2015 12:33:10 GMT

{"badRequest": {"message": "Malformed request url", "code": 400}}

List API extensions

List availability zones