Skip to content

Effective quotas for a project across all services.

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

Service-Quotas-shape read: one item per quota dimension registered by any service (network, lb, dns,…), with the effective limit, its source (override when a platform.quota_overrides row exists, else default), and a best-effort current usage (null when the usage probe fails the read never fails over one service’s count). Any role with a binding scoped to the project sees this; admin writes go through PUT /v1/admin/quotas/projects/{pid}/{dimension}..

projectId
required
string
/^p-[a-z0-9-]+$/

Effective quotas.

Media typeapplication/json

effective-quota union view.

object
enforced
required

True when at least one listed quota, rate limits aside, is enforced. False: the install does not enforce quotas for any of these services, and the list is usage only.

boolean
items
required
Array<object>

One dimension’s effective quota for the project. usage is a best-effort point-in-time count and null when the probe failed.

object
dimension
required

E.g. network.vpcs.count

string
service
required
string
unit
required

How the limit and usage are measured: count, vcpus, bytes, iops, mbps (promised MB/s) or per_minute (a rate limit). The set is closed.

string
limit
required

The effective limit; -1 is unlimited, 0 denies all creates.

integer
>= -1
source
required

override: this project’s own limit. default: the install-wide default (GET /v1/admin/quotas/defaults). builtin: the dimension has no default row yet, so its compiled seed applies. system: a project of the operator organization, which is unlimited on the aggregate dimensions unless it has an override. organization: the org admin’s allocation or per-project default. unenforced: the operator does not enforce this service’s quotas, so the limit is -1 whatever the rows say.

string
Allowed values: override default builtin system organization unenforced
usage
integer
nullable
enforced
required

Whether a create can be refused over this limit. False while the operator does not enforce the dimension’s service; the usage is then for information only. Rate limits (per_minute) are always enforced.

boolean
configuredLimit

The limit the rows set for this project, whether or not it is enforced; -1 is unlimited. Equal to limit while enforced is true. While enforced is false, limit reads -1 and this is what enforcement would apply: an operator’s project override, the install default, and so on. Absent only when that read failed.

integer
>= -1
configuredSource

Where configuredLimit comes from: the source values except unenforced. Equal to source while enforced is true.

string
Allowed values: override default builtin system organization

Example

{
"items": [
{
"source": "override",
"configuredSource": "override"
}
]
}

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"
}
]
}

Resource not found.

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"
}
]
}