Skip to main content

ServiceQuota

No description

type ServiceQuota {
  quotaId: BigInt!
  orgId: BigInt
  appId: BigInt
  tierId: BigInt
  metric: String!
  limitValue: BigInt!
  period: String!
  actionOnExceed: String!
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields​

ServiceQuota.quotaId ● BigInt! non-null scalar​

Unique quota rule id (BigInt as a decimal string).

ServiceQuota.orgId ● BigInt scalar​

Organization this rule is scoped to (BigInt as a decimal string); null if not org-scoped.

ServiceQuota.appId ● BigInt scalar​

App this rule is scoped to (BigInt as a decimal string); null if not app-scoped.

ServiceQuota.tierId ● BigInt scalar​

Access tier this rule is scoped to (BigInt as a decimal string); null if not tier-scoped.

ServiceQuota.metric ● String! non-null scalar​

The metered resource this rule limits (e.g. "api_requests", "storage_bytes"). Free-form metric key, matched exactly.

ServiceQuota.limitValue ● BigInt! non-null scalar​

Maximum allowed amount of the metric per period, as a BigInt decimal string.

ServiceQuota.period ● String! non-null scalar​

Time window the limit applies over. Free-form string; defaults to "per_minute" (typical values: "per_minute", "per_hour", "per_day").

ServiceQuota.actionOnExceed ● String! non-null scalar​

What happens when the limit is exceeded. Free-form string; defaults to "throttle" (typical values: "throttle" to rate-limit, "block" to reject).

ServiceQuota.createdAt ● DateTime! non-null scalar​

When the rule was created (ISO-8601 UTC timestamp).

ServiceQuota.updatedAt ● DateTime! non-null scalar​

When the rule was last updated (ISO-8601 UTC timestamp).

Returned By​

effectiveQuota query ● quotasForApp query ● quotasForOrg query ● setQuota mutation