CA API Gateway 9.1

9.4 9.1

Query Throughput Quota Assertion

The Query Throughput Quota Assertion is used to query the status of a custom throughput quota counter from the . The results are then placed into context variables.
gateway83
The
Query Throughput Quota Assertion
 is used to query the status of a custom throughput quota counter from the Apply Throughput Quota Assertion. The results are then placed into context variables.
The Query Throughput Quota assertion is most useful when you have used a
custom
 counter ID in the Apply Throughput Quota Assertion.
Context Variables Created by This Assertion
The Query Throughput Quota assertion sets the following context variables.
The <
prefix
> is set in the assertion properties and is optional. There is no default.
Variable
Description
$<
prefix
>.
counter.name 
The full name of the matching counter.
$<
prefix
>.
counter.sec
The count for the previous second.
$<
prefix
>.
counter.min
The count for the previous minute.
$<
prefix
>.
counter.hr
The count for the previous hour.
$<
prefix
>.
counter.day
The count for the previous day.
$<
prefix
>.
counter.mnt
The count for the previous month.
$<
prefix
>.
counter.lastupdate
The date the counter was last updated, in the format yyyy-mm-dd.
Using the Assertion
  1. Do one of the following:
    1. To add the assertion to the Policy Development window, see Add an Assertion.
    2.  To change the configuration of an existing assertion, proceed to step 2 below.
  2. Right-click
    Query Throughput Quota for <counter name>
     in the policy window and select
    Throughput Quota Query Properties
     or double-click the assertion in the policy window. The assertion properties are displayed. 
  3. Configure the dialog as follows:
    Field
    Description
    Existing Counter Name
    Enter the name of the throughput quota counter being queried.
    The counter name entered here should be the actual resolved counter ID from the Apply Throughput Quota Assertion. If you simply repeat the context variable from the other assertion, the results may be incorrect.
    For example, the Apply Throughput Quota assertion uses the counter ID: "QA-${request.authenticateduser}" and you want to query for user "jsmith". In this case, you would enter the counter name "QA-jsmith" in the Query Throughput Quota assertion. If you simply repeated "QA-${request.authenticateduser}" as the counter name, the results will be correct if the user performing the query is "jsmith".
    Variable Prefix
    Optionally, enter a prefix that is added to the context variables created by this assertion. This prefix ensures uniqueness and prevents the variables from overwriting each other when multiple instances of this assertion appear in a policy.
    If no prefix is set, the variables appear as
    ${counter.name}
    , etc., instead of
    ${<prefix>.counter.name}
    .
    For an explanation of the validation messages that are displayed, see "Context Variable Validation" in Context Variables.
  4. Click [
    OK
    ].

Content feedback and comments