Get Quota

GET

/taxonomy/v1/quotas/{id}

curl --request GET \
  --url https://example.com/taxonomy/v1/quotas/example

Returns one quota catalogue entry by unique ID

Parameters

Path Parameters

id

required

string

The unique identifier of the quota to retrieve

Responses

200

OK

Media type application/json

Quota

A catalogue entry: one metric, the scope level it applies at, and the default limit that applies wherever no override has been set. The catalogue is platform-seeded, so every field is server-owned.

object

id

The unique identifier of the quota

stringOutput only

name

The handle of the quota, e.g. “workspaces-per-organisation”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Unique across the catalogue. Used to address the quota by name or id.

stringOutput only

metric

The metric this quota limits, following the <service>/<scope>/<resource> convention (e.g. “taxonomy/organisation/workspaces”). What is measured, as distinct from name, which is how the entry is addressed.

stringOutput only

display_name

A human-readable label for the quota, e.g. “Workspaces per organisation”

stringOutput only

description

A longer explanation of what this quota limits

stringOutput only

unit

The unit the limit is expressed in

string format: enum Output only

Allowed values: TAXONOMY_QUOTA_UNIT_UNSPECIFIED TAXONOMY_QUOTA_UNIT_COUNT

quota_type

Whether the quota caps a concurrent stock (ALLOCATION) or a rate (RATE)

string format: enum Output only

Allowed values: TAXONOMY_QUOTA_TYPE_UNSPECIFIED TAXONOMY_QUOTA_TYPE_ALLOCATION TAXONOMY_QUOTA_TYPE_RATE

scope_type

The scope level this quota applies at

string format: enum Output only

Allowed values: TAXONOMY_SCOPE_TYPE_UNSPECIFIED TAXONOMY_SCOPE_TYPE_PLATFORM TAXONOMY_SCOPE_TYPE_ORGANISATION TAXONOMY_SCOPE_TYPE_WORKSPACE TAXONOMY_SCOPE_TYPE_GROUP

default_limit

required

The limit that applies wherever no override has been set for a scope. The only mutable field of a quota: everything else is platform-seeded identity.

integer format: int32

adjustable

Whether an override may be set for this quota at all

booleanOutput only

create_time

Created Timestamp

The timestamp when the quota was created

string format: date-time Output only

update_time

Updated Timestamp

The timestamp when the quota was last updated

string format: date-time Output only

Example

{
  "unit": "TAXONOMY_QUOTA_UNIT_UNSPECIFIED",
  "quota_type": "TAXONOMY_QUOTA_TYPE_UNSPECIFIED",
  "scope_type": "TAXONOMY_SCOPE_TYPE_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}