Help Center/ ROMA Connect/ User Guide/ Service Integration Guide/ Configuring API Control Policies/ Configuring API Credential Quotas
Updated on 2023-05-17 GMT+08:00
View PDF
Share

Configuring API Credential Quotas

A credential quota limits the total number of times that an API can be called by a credential in a specified period to protect backend services. You can create a credential quota policy to limit the number of API calls made by credentials bound to the policy.

A credential quota policy and a client are independent of each other. The policy takes effect on the credential only after the credential is bound to the policy.

Constraints

  • One credential can be bound to only one credential quota policy, but one credential quota policy can be bound to multiple credentials.
  • Only users assigned with the Tenant Administrator permission can view and configure credential quota policies.

Creating a Credential Quota Policy

  1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
  2. In the navigation pane on the left, choose API Connect > Credentials. On the Credential Quota Policies tab, click Create Credential Quota Policy.
  3. On the page displayed, configure policy information.
    Table 1 Parameters for creating a credential quota policy

    Parameter

    Description

    Name

    Enter a credential quota policy name. Using naming rules facilitates future search.

    Effective On

    Select the start time for the quota policy to take effect. For example, if Effective On is set to Aug 8, 2020 05:05:00 and Period is set to 1 hour, the quota policy took effect on Aug 8, 2020 05:05:00, and the period from the fifth minute of an hour to the fifth minute of the next hour is a cycle, for example, from 05:05:00 to 06:05:00.

    Period

    Enter the quota duration in seconds, minutes, hours, or days. This parameter must be used along with Max. API Requests to limit the total number of times an API can be called by a credential within the specified period.

    Max. API Requests

    Enter the maximum number of times that an API can be called by a credential. This parameter is used along with Period.

    Description

    Describe the credential quota policy.
  4. Click OK.

    After the credential quota policy is created, you also need to perform the operation described in Binding a Quota Policy to a Credential to make the policy take effect for APIs.

Binding a Quota Policy to a Credential

  1. On the Credential Quota Policies tab page, click the name of a policy to go to the details page.
  2. In the Bound Credential List area, click Bind to Credentials.
  3. In the dialog box displayed, select the credentials to bind the policy to.

    Search by credential name is supported.

  4. Click OK.

    A credential can be bound only to one quota policy. If a credential is bound to a quota policy repeatedly, the original quota policy will be unbound.