Get Effective Quota

GET

/taxonomy/v1/organisations/{organisation}/effective-quotas/{id}

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

Returns the limit in force for one organisation and the usage counted against it — the reading a member of that organisation sees for itself

Parameters

Path Parameters

organisation

required

string

The organisation to read the effective quota for

id

required

string

The quota to read, addressed by either its unique identifier or its metric key. A value shaped like a UUID resolves by identifier; anything else resolves by metric. A metric is URL-encoded, so the / separators in taxonomy/organisation/workspaces are sent as %2F and the value occupies a single path segment.

Responses

200

OK

Media type application/json

Effective Quota

What one scope is actually allowed, and how much of it is in use: the override where one has been set, otherwise the catalogue default, alongside the live count measured against it.

object

metric

The metric this reading is for

stringOutput only

effective_limit

The limit in force for this scope: the override, else the catalogue default

integer format: int32 Output only

current_usage

The current usage counted against the limit

stringOutput only

Example ^generated

{}

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"
    }
  ]
}