GET Limits

Overview

This API lists the current limits for the account.

Classification

  • Get

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/{tenant_id}/limits

HTTP Request Header

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body

  • none

Request Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
tenant_id URL UUID ID for the tenant. required - Terminate 403, 404
token Header Authentication token string Keystone authentication token. required - Terminate 401

Response

HTTP Response Header

Format

HTTP/1.1 200 OK
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

HTTP Response Code

Response Codes
response code condition
200 normal end
401 unauthorized
403 tenant is not available
405 request URL or method is invalid
500 compute fault

HTTP Response Body

Format

Default values are shown in Sample API Response.

{
  "limits": {
    "absolute": {
      "maxPersonality": "<maxPersonality>",
      "maxPersonalitySize": "<maxPersonalitySize>",
      "maxServerMeta": "<maxServerMeta>",
      "maxTotalInstances": "<maxTotalInstances>",
      "maxTotalKeypairs": "<maxTotalKeypairs>",
      "totalInstanceUsed": "<totalInstanceUsed>"
    },
    "rate": "<rate>"
  }
}

Response Parameter

Response Parameters
item format   description
limits Limit Array   Rate and absolute limits

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/limits

Request Header

POST /v2/b322a85578de48beba0f92acce57869b/limits HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

Sample API Response

Response Header

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

Response Body

Default values are shown in the below sample.

{
  "limits": {
    "absolute": {
      "maxPersonality": 10,
      "maxPersonalitySize": 10240,
      "maxServerMeta": 128,
      "maxTotalInstances": 128,
      "maxTotalKeypairs": 100,
      "totalInstanceUsed": 0
    },
    "rate": []
  }
}