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.

Requests

    Get rules for org123456789 organization (default pagination)
        GET https://quota.bam.api.here.com/v1/realms/org123456789/rules
    Get rules for org123456789 organization (with pagination paramaters)
        GET https://quota.bam.api.here.com/v1/realms/org123456789/rules?offset=2
        GET https://quota.bam.api.here.com/v1/realms/org123456789/rules?limit=30
        GET https://quota.bam.api.here.com/v1/realms/org123456789/rules?limit=75&offset=6
    Get rules for org123456789 organization with status=active
        GET https://quota.bam.api.here.com/v1/realms/org123456789/rules?status=active

Response: HTTP 200 OK

    HTTP 200 OK
{
    "total": 2,
    "limit": 100,
    "items": [
        {
            "ruleId": "CUSTOMER-QUOTA-db8ac3fb-f560-482c-a1e5-1626d503e4cd",
            "hrn": "hrn:here:quota::org123456789:CUSTOMER-QUOTA-db8ac3fb-f560-482c-a1e5-1626d503e4cd",
            "name": "Example rule",
            "description": "Alert on Log search IO threshold 10Gi.",
            "status": "active",
            "queryConditions": [
                {
                    "key": "featureId",
                    "value": "hrn:here:portal::org123456789:logs"
                }
            ],
            "usageThresholdCondition": {
                "thresholdType": "percentage",
                "threshold": 70,
                "usageLimit": 70
            },
            "actions": [
                "alert"
            ],
            "actionableEntity": {
                "entityType": "projectHrn",
                "entityId": "hrn:here:authorization::org123456789:project/my-project-0000"
            },
            "timeRange": {
                "duration": "monthly"
            },
            "ruleType": "alert",
            "emailNotifications": [
                "example@here.com",
                "test@here.com"
            ],
            "created": "2021-09-03T07:08:23Z",
            "modified": "2021-09-03T07:08:23Z",
            "createdBy": "dhIQFVejQgPkTXLn8CtH",
            "updatedBy": "dhIQFVejQgPkTXLn8CtH"
        },
        {
            "ruleId": "CUSTOMER-QUOTA-8e95827b-141c-4848-8cd4-9f800ea84fc0",
            "hrn": "hrn:here:quota::org123456789:CUSTOMER-QUOTA-8e95827b-141c-4848-8cd4-9f800ea84fc0",
            "name": "LogSearch IO Alert",
            "description": "Alert on Log search IO threshold over 10GiB.",
            "status": "active",
            "queryConditions": [
                {
                    "key": "featureId",
                    "value": "hrn:here:portal::org123456789:logs"
                }
            ],
            "usageThresholdCondition": {
                "thresholdType": "absolute",
                "threshold": 10
            },
            "actions": [
                "alert"
            ],
            "timeRange": {
                "duration": "daily"
            },
            "ruleType": "alert",
            "emailNotifications": [
                "example@here.com",
                "test@here.com"
            ],
            "created": "2021-08-20T11:26:50Z",
            "modified": "2021-08-20T11:26:50Z",
            "createdBy": "dhIQFVejQgPkTXLn8CtH",
            "updatedBy": "dhIQFVejQgPkTXLn8CtH"
        }
    ],
    "nextOffset": 0,
    "lastOffset": 0
}

results matching ""

    No results matching ""