Get all quota rules
The following information shows the request status for all of the quota rules provided by the Quota API for your organization. This supports pagination (offset & limit) and allows filtering of results by multiple fields.
You must have one of the following permissions:
Requests
This request gets the rules for the org123456789 organization.
GET https:
Parameters
The parameters shown here are only necessary for this request. For a complete list of parameters, see the Quota API Reference documentation.
realmId required | string [ 5 .. 30 ] characters Example: org123456789 Your org ID. |
subscriptionId | string ^[a-z0-9A-Z-]{1,50}$ less than or equal to 256 characters. Subscription ID. |
quotaRuleReferenceId | string ^[a-z0-9A-Z-]{1,50}$ less than or equal to 256 characters. Example: quotaRuleReferenceId=QUOTA-RULE-1152a465-7b67-44ac-882f-2331089cf2c4 QuotaRuleReference ID. Rule ID from Technical product catalog. |
quotaReferenceId | string ^[a-z0-9A-Z-]{1,50}$ less than or equal to 256 characters Example: quotaReferenceId=QUOTA-1152a465-7b67-44ac-882f-2331089cf2c4 QuotaReference id. Quota Id from Technical product catalog. |
status | string less than or equal to 256 characters Enum: "active" "inactive" Example: status=active Status of the rule. |
productId | string ^[a-z0-9A-Z-]{1,50}$ less than or equal to 256 characters Product ID. |
limit | integer [ 1 .. 100 ] Default: 100 Number of records in one page to return. Allowed values are in range <1,100>. Default is 100 records. 1,100> |
offset | integer greater than or equal to 0 Example: offset=2 Numeric offset value indicating which page is to be returned. For example, when there are 1000 records and the limit is 50, offset 2 returns records from index 100 to 149. |
Response: HTTP 200 OK
{
"total": 10,
"limit": 2,
"items":
[
{
"ruleId": "CUSTOMER-QUOTA-1152a465-7b67-44ac-882f-2331089cf2c4",
"hrn": "hrn:here:quota::olp-here:CUSTOMER-QUOTA-dec030a3-738a-4925-99d6-0aec809d5f26",
"name": "string",
"description": "string",
"status": "active",
"queryConditions":
[
{
"key": "featureId",
"value": "hrn:here:data:test123"
}
],
"usageThresholdCondition":
{
"thresholdType": "percentage",
"threshold": 50,
"usageLimit": 500
},
"actions":
[
"alert"
],
"actionableEntity":
{
"entityType": "appId",
"entityId": "app1"
},
"timeRange":
{
"duration": "monthly"
},
"subscriptionId": "8c2daw342341234124",
"ruleType": "quota",
"productId": "9vewqw323423",
"quotaReferenceId": "QUOTA-<UUID>",
"quotaRuleReferenceId": "QUOTA-RULE-<UUID>",
"emailNotifications":
[
"string"
],
"created": "2021-02-04T07:45:25+00:00",
"modified": "2021-02-04T07:49:03+00:00",
"createdBy": "<user-id>",
"updatedBy": "<user-id>"
}
],
"nextOffset": 0,
"lastOffset": 0
}