Service Classes

Description

Service Classes are the objects used to manage Service-specific limits assocaited with a Developer Class.

Object Fields

id

The id field is the primary identifier for the object.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				yes	yes	no	yes	no

created

The date that this object was created.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	20	date-time		yes	yes	no	yes	no

updated

The date this object was last updated.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	20	date-time		yes	yes	no	yes	no

rate_limit_ceiling

API Key specific Rate Limit the Proxy Service will enforce if both Rate Limit Enforcement is enabled and Rate Limit Overrides are allowed in the Dashboard API Settings Tab. This value takes precidence over the Service Definition Default Rate Limit. Note: The period ("Minute", "Hour", "Day", "Month") for the rate_limit_ceiling (Custom Rate Limit) is set in the Service Definition's Rate Limit Period configuration item in the Dashboard API Settings Tab.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				yes	no	no	yes	no

qps_limit_ceiling

API Key specific QPS Limit the Proxy Service will enforce if both Throttling Limit Enforcement is enabled and Throttling Limit Overrides are allowed in the Dashboard API Settings Tab. This value takes precedence over the Service Definition Default Rate Limit. This value is only enforced if the Aggregate QPS has not been reached for the Service Definition.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
integer				yes	no	no	yes	no

rate_limit_exempt

Toggle whether this key has an unlimited rate limit. This setting is only applied by the Proxy Service at runtime if the Rate Limit feature is enabled and the Default Rate Limit Override is allowed.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				yes	no	no	yes	no

qps_limit_exempt

Toggle whether this key allows unlimted qps. This setting is only applied by the Proxy Service at runtime if the Throttling Limit Enforcement feature is enabled and Throttling Limit Override is allowed. This setting does not take precidence over any Aggregate QPS setting on the service definition.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
boolean				yes	no	no	yes	no

limits

Limits describe how this key may be limited, including information from the service definition. See below for a more detailed description of the elements of the limits array.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
array				yes	yes	no	no	no

object_type

The type of the object.

type	maxLength	format	default	optional	readonly	createonly	queryable	sortable
string	32			yes	yes	no	no	no

Relationships

Object Methods

The service_class namespace contains the following methods for manipulating services.

service_class.update

Update a service class .

service_class.fetch

Get a specific service class .

service_class.validate

Validate a service class .

version 5 as of 12 years ago by Jeremy Pollock