@akamai/openapi-ts
    Preparing search index...

    Type Alias PutAlertDefinitionData

    type PutAlertDefinitionData = {
        body: {
            channel_ids?: number[];
            description?: string;
            entity_ids?: string[];
            label?: string;
            rule_criteria?: {
                rules?: {
                    aggregate_function?: "avg" | "sum" | "min" | "max";
                    dimension_filters?: {
                        dimension_label?: string;
                        operator?: "eq" | "neq" | "startswith" | "endswith";
                        value?: string;
                    }[];
                    metric?: string;
                    operator?: "eq"
                    | "gt"
                    | "lt"
                    | "gte"
                    | "lte";
                    threshold?: number;
                }[];
            };
            severity?: 0
            | 1
            | 2
            | 3;
            status?: "enabled" | "disabled";
            trigger_conditions?: {
                criteria_condition?: "ALL";
                evaluation_period_seconds?: number;
                polling_interval_seconds?: number;
                trigger_occurrences?: number;
            };
        };
        path: { alertId: number; serviceType: string };
        query?: never;
        url: "monitor/services/{serviceType}/alert-definitions/{alertId}";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        channel_ids?: number[];
        description?: string;
        entity_ids?: string[];
        label?: string;
        rule_criteria?: {
            rules?: {
                aggregate_function?: "avg" | "sum" | "min" | "max";
                dimension_filters?: {
                    dimension_label?: string;
                    operator?: "eq" | "neq" | "startswith" | "endswith";
                    value?: string;
                }[];
                metric?: string;
                operator?: "eq"
                | "gt"
                | "lt"
                | "gte"
                | "lte";
                threshold?: number;
            }[];
        };
        severity?: 0
        | 1
        | 2
        | 3;
        status?: "enabled" | "disabled";
        trigger_conditions?: {
            criteria_condition?: "ALL";
            evaluation_period_seconds?: number;
            polling_interval_seconds?: number;
            trigger_occurrences?: number;
        };
    }

    Type Declaration

    • Optionalchannel_ids?: number[]

      The identifiers for the alert channels to use for the alert. Run the List alert channels operation and store the id for the applicable channels.

    • Optionaldescription?: string

      An additional description for the alert definition.

    • Optionalentity_ids?: string[]

      The id for each individual entity from a service_type. Get this value by running the list operation for the appropriate entity. For example, if your entity is one of your PostgreSQL databases, run the List PostgreSQL Managed Databases operation and store the id for the appropriate database from the response. You also need read_only access to the scope for the service_type for each of the entity_ids.

      📘

      The format type for an entity_id may vary, based on the Akamai Cloud service_type. For example, the dbaas service returns an integer value for an id, that you'd use for the entity_id. Other services may return a string for their id. With the Alerts operations, all of these formats are recognized as an entity_id, when you include them as a string.

    • Optionallabel?: string

      The name of the alert definition. This is used for display purposes in Akamai Cloud Manager.

    • Optionalrule_criteria?: {
          rules?: {
              aggregate_function?: "avg" | "sum" | "min" | "max";
              dimension_filters?: {
                  dimension_label?: string;
                  operator?: "eq" | "neq" | "startswith" | "endswith";
                  value?: string;
              }[];
              metric?: string;
              operator?: "eq"
              | "gt"
              | "lt"
              | "gte"
              | "lte";
              threshold?: number;
          }[];
      }

      Details for the rules required to trigger the alert.

      • Optionalrules?: {
            aggregate_function?: "avg" | "sum" | "min" | "max";
            dimension_filters?: {
                dimension_label?: string;
                operator?: "eq" | "neq" | "startswith" | "endswith";
                value?: string;
            }[];
            metric?: string;
            operator?: "eq"
            | "gt"
            | "lt"
            | "gte"
            | "lte";
            threshold?: number;
        }[]

        The individual rules that make up the alert definition.

    • Optionalseverity?: 0 | 1 | 2 | 3

      The severity of the alert. Supported values include 3 for info, 2 for low, 1 for medium, and 0 for severe.

    • Optionalstatus?: "enabled" | "disabled"

      The current status of the alert. You can set this to enabled or disabled.

    • Optionaltrigger_conditions?: {
          criteria_condition?: "ALL";
          evaluation_period_seconds?: number;
          polling_interval_seconds?: number;
          trigger_occurrences?: number;
      }

      The conditions that need to be met to send a notification for the alert.

      • Optionalcriteria_condition?: "ALL"

        Signifies the logical operation applied when multiple metrics are set for an alert definition. For example, if you wanted to apply both cpu_usage > 90 and memory_usage > 80, ALL is the criteria_condition. Currently, only ALL is supported.

      • Optionalevaluation_period_seconds?: number

        The time period over which data is collected before evaluating whether the alert definition's threshold has been met or exceeded.

        📘

        During the beta, only a value of 300 seconds is supported.

      • Optionalpolling_interval_seconds?: number

        The frequency at which the metric is checked for a change in state. For example, with cpu_usage set as your metric and this set to 300, your cpu_usage is checked every 5 minutes for some change in its state.

        📘

        During the beta, only a value of 300 seconds is supported.

      • Optionaltrigger_occurrences?: number

        The minimum number of consecutive polling_interval_seconds periods that the threshold needs to be breached to trigger the alert.

    path: { alertId: number; serviceType: string }

    Type Declaration

    • alertId: number

      The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable alert definition.

    • serviceType: string

      The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate service_type.

    query?: never
    url: "monitor/services/{serviceType}/alert-definitions/{alertId}"

    Settings

    Member Visibility

    On This Page

    Properties