Skip to content
StratumStratum Docs

Show whether quotas are enforced.

GET
/v1/admin/quotas/enforcement
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/admin/quotas/enforcement \
  --header 'Authorization: Bearer <token>'

. The install-wide switch and each service’s effective state. A fresh single-node install starts off, a cluster on; an upgraded install keeps enforcing. Install-scope (quotas:GetQuotaEnforcement).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The enforcement state.

Media typeapplication/json

Whether quotas are enforced: install-wide, and per service. While a service is not enforced its limits resolve to -1 and no create is refused; usage is still counted. Rate limits are not affected.

object
enforced
required

The install-wide switch. A service without its own setting follows it.

boolean
source
required

setting: recorded, by the install (off on a single node, on for a cluster) or by an operator. default: nothing recorded, so enforced.

string
Allowed values: setting default
updatedAt
string format: date-time
updatedBy
string
services
required

Every service with enforceable quota dimensions.

Array<object>

One service’s enforcement.

object
service
required

The quota dimensions’ service, e.g. compute, network, dns.

string
enforced
required

What applies to the service’s quotas.

boolean
override

The service’s own setting; absent = follows the install-wide switch.

boolean
updatedAt
string format: date-time
updatedBy
string
disabled

The service is switched off.

boolean

Example 

{
  "source": "setting"
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}