Get a quota, with every scope key's value and usage

An unknown or deprecated quota is 404.

GET

https://quotas.ezghcloud.com/v1/organizations/{orgId}/quotas/{quota}

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired
format: uuid
quotastringrequired
The quota's ID: widgets.widgetsPerProject.

maxLength: 96, pattern: ^[a-z]{2,32}\.[a-z][A-Za-z0-9]{2,63}(\.[a-z][A-Za-z0-9]{1,63})?$

Query parameters

scopeKeyoptionalstring
Only this scope key in scopes.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
regionoptionalstring
Only this region's rows of a perRegion quota; without it, a row per region.

pattern: ^([a-z]{2}-[a-z]+-[0-9]+)?$

Returns

200

The quota.

JSON

adjustablebooleanrequired
capacityinteger | nullrequired
rate quotas: the bucket's capacity for value (what usage.used is out of), else null.

minimum: 0
defaultintegerrequired
The default for the organization's tier.

minimum: 0
descriptionstringrequired
displayNamestringrequired
idstringrequired
. or ...

maxLength: 96, pattern: ^[a-z]{2,32}\.[a-z][A-Za-z0-9]{2,63}(\.[a-z][A-Za-z0-9]{1,63})?$
kindallocationorrateorusageorconcurrencyrequired
perRegionbooleanrequired
regionstringrequired
A region (us-west-1), or "" for what isn't regional.

pattern: ^([a-z]{2}-[a-z]+-[0-9]+)?$
resourceTypestring | nullrequired
scopeorganizationorprojectorresourcerequired
servicestringrequired
The owning product's namespace.
serviceNamestring | nullrequired
The owning product's name, from its registration (Widgets), or null.
sourceoverrideororganizationOverrideortierordefaultrequired
Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
tierstring | nullrequired
The organization's tier when source is tier, else null.
unitstringrequired
usagenullorUsagerequired
null for narrower scopes without ?scopeKey= (see usageSummary and the quota's scopes), and for a perRegion quota without ?region=.
2 variants
One of the following:
null
Usage
View Usage schema →
4 properties
periodStartnullorInstantrequired
usage quotas only.

2 variants
One of the following:
null
Instant
resetsAtnullorInstantrequired
usage quotas only.

2 variants
One of the following:
null
Instant
stateavailableorunavailablerequired
unavailable: the product (allocation) or Quotas' Redis didn't answer in time; never a stale number.

usedinteger | nullrequired
allocation: in use; usage: this billing period; concurrency: in flight; rate: tokens in use of the bucket's capacity (capacity minus whole tokens available), never above capacity. null when unavailable.

minimum: 0
usageSummarynullorUsageSummaryrequired
When usage is null: where the scope keys (and regions) stand. Else null.
2 variants
One of the following:
null
UsageSummary
View UsageSummary schema →
7 properties
maxLimitinteger | nullrequired
…its limit.

minimum: 0
maxRegionnullorRegionrequired
…its region.

2 variants
One of the following:
null
Region
maxScopeKeynullorUuidrequired
…its scope key.

2 variants
One of the following:
null
Uuid
maxUsedinteger | nullrequired
The row using the largest share of its limit: its usage.

minimum: 0
scopeKeysintegerrequired
Rows (scope key and region) with known usage.

minimum: 0
scopeKeysNearintegerrequired
Rows at 80% of their limit (the value; a rate quota's capacity) or more.

minimum: 0
stateavailableorunavailablerequired
unavailable: some usage couldn't be read; the counts are of what could be.
valueintegerrequired
The value that applies: the organization's, a scope key without its own override's, or with ?scopeKey= that scope key's.

minimum: 0
windowstring | nullrequired
rate quotas: PT1S to PT1H.
scopesarray ofobjectrequired
Every scope key with an override or known usage, or only ?scopeKey=; for a perRegion quota, a row per region (or only ?region=). An organization-scoped quota's scope key is the organization.
7 properties
- capacityinteger | nullrequired
  minimum: 0
- regionstringrequired
  A region (us-west-1), or "" for what isn't regional.
  
  pattern: ^([a-z]{2}-[a-z]+-[0-9]+)?$
- scopeKeystringrequired
  A lowercase UUID.
  
  pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- sourceoverrideororganizationOverrideortierordefaultrequired
  Which value applied: an override for the scope key, one for the whole organization, the tier's default, or the quota's default.
- tierstring | nullrequired
- usageobjectrequired
  4 properties
  periodStartnullorInstantrequired
  usage quotas only.
  
  2 variants
  One of the following:
  null
  Instant
  resetsAtnullorInstantrequired
  usage quotas only.
  
  2 variants
  One of the following:
  null
  Instant
  stateavailableorunavailablerequired
  unavailable: the product (allocation) or Quotas' Redis didn't answer in time; never a stale number.
  
  usedinteger | nullrequired
  allocation: in use; usage: this billing period; concurrency: in flight; rate: tokens in use of the bucket's capacity (capacity minus whole tokens available), never above capacity. null when unavailable.
  
  minimum: 0
- valueintegerrequired
  minimum: 0
usageAvailablebooleanrequired
false when some usage couldn't be read: rows known only from the product's usage are then missing, and rows shown have usage unavailable.

400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

401

unauthenticated: no credential, or one that doesn't check out.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON

errorobjectrequired
4 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- issuesoptionalarray ofobject
  invalid_request: one entry per problem, at a dotted path.
  
  2 properties
  messagestringrequired
  pathstringrequired
- quotaoptionalobject
  quota_exceeded: the quota that refused the request (contracts/quotas.md, "When a quota is exceeded"). Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.