List Quotas
const url = 'https://example.com/taxonomy/v1/quotas';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/taxonomy/v1/quotasReturns a paginated list of quota catalogue entries
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”The maximum number of quotas to return. The service may return fewer than this value. If unspecified, at most 20 quotas will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListQuotas call.
Provide this to retrieve the subsequent page. When paginating,
all other parameters provided to ListQuotas must match the call
that provided the page token.
AIP-160 filter expression. Filterable fields: adjustable, create_time, default_limit, description, display_name, id, metric, name, quota_type, scope_type, unit, update_time.
AIP-132 order_by expression. Sortable fields: create_time, display_name, metric, name, quota_type, scope_type, unit, update_time.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListQuotasResponse
Response message for ListQuotas.
object
The list of quotas
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
The unique identifier of the quota
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.
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.
A human-readable label for the quota, e.g. “Workspaces per organisation”
A longer explanation of what this quota limits
The unit the limit is expressed in
Whether the quota caps a concurrent stock (ALLOCATION) or a rate (RATE)
The scope level this quota applies at
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.
Whether an override may be set for this quota at all
Created Timestamp
The timestamp when the quota was created
Updated Timestamp
The timestamp when the quota was last updated
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "quotas": [ { "unit": "TAXONOMY_QUOTA_UNIT_UNSPECIFIED", "quota_type": "TAXONOMY_QUOTA_TYPE_UNSPECIFIED", "scope_type": "TAXONOMY_SCOPE_TYPE_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
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
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
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.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}