API Management
13.2 13.1 13.0 12.2 12.1 12.0 11.0
13.2 13.1 13.0 12.2 12.1 12.0 11.0

Reset Quota

Contents

The Reset Quota policy can be used to reset the quota limit of a user. This helps in cases where a quota needs to be reset for a particular user using the administration API.

Configuration

The properties that have to be configured to use the policy are described below.

image2014-12-1 0:18:51.png
Figure 1: Reset Quota Policy Configuration properties

Click the Edit  Edit.png button corresponding to the above properties to configure Type, Variable Name and Default Value for the corresponding properties.
image2014-10-8 17:52:11.png
Figure 2: Dialog box to choose Identifier Type

Refer to the Configuring Message Part Identifier section to configure these parameters.

Example

Configure the policy with the details below:

  • Quota Identifier:

    • Type: PARAMETER

    • Variable Name: clientId (ID of the client making the request)

    • Default Value: default (any value)

      This Quota Identifier should be the same as the quota identifier defined in Quota Policy.

  • API Project Name:

    • Type: PARAMETER

    • Variable Name: projectName

    • Default Value: default (any value)

  • API Project Version:

    • Type: PARAMETER

    • Variable Name: projectVersion

    • Default Value: default (any value)

  • Deployed Environment:

    • Type: PARAMETER

    • Variable Name: environmentName

    • Default Value: default (any value)

  • Quota Policy Name:

    • Type: PARAMETER

    • Variable Name: QuotaPolicyName

    • Default Value: default (any value)

image2014-12-23 19:4:39.png
Figure 3: Reset Quota policy configured with values as provided in the Example

When the quota limit of a client for a project exceeds the set limit, an administrative tool can send a request to the project containing the policy that is set with appropriate parameters to reset the quota so that the client will have a chance to send requests in special cases.