Skip to content
EZGH CloudDocs

QuotaSummary

View as Markdown

Fields

  • 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:

      • resetsAtnullorInstantrequired

        usage quotas only.

        2 variants

        One of the following:

      • 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:

      • maxScopeKeynullorUuidrequired

        …its scope key.

        2 variants

        One of the following:

      • 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.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close