Type Alias GetAlertDefinitionResponses

Type Declaration

• alert_channels: { id: number; label: string; type: "email"; url: string }[]

  The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.

• class: "shared" | "dedicated"

  The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a service_type of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.

• created: string

  When the alert definition was created.

• created_by: string

  For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.

• description: string

  An additional description for the alert definition.

• entity_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.

  📘

  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.

• has_more_resources: boolean

  Whether there are additional entity_ids associated with the alert for which the user doesn't have at least read-only access.

• id: number

  Filterable The unique identifier for the alert definition.

• label: string

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

• rule_criteria: {
      rules: {
          aggregate_function: "avg" | "sum" | "min" | "max";
          dimension_filters: {
              dimension_label: string;
              label: string;
              operator: "eq" | "neq" | "startswith" | "endswith";
              value: string;
          }[];
          label: string;
          metric: string;
          operator: "eq"
          | "gt"
          | "lt"
          | "gte"
          | "lte";
          threshold: number;
          unit:
              | "number"
              | "byte"
              | "second"
              | "percent"
              | "bit_per_second"
              | "millisecond"
              | "KB"
              | "MB"
              | "GB";
      }[];
  }

  Details for the rules required to trigger the alert.

  • rules: {
        aggregate_function: "avg" | "sum" | "min" | "max";
        dimension_filters: {
            dimension_label: string;
            label: string;
            operator: "eq" | "neq" | "startswith" | "endswith";
            value: string;
        }[];
        label: string;
        metric: string;
        operator: "eq"
        | "gt"
        | "lt"
        | "gte"
        | "lte";
        threshold: number;
        unit:
            | "number"
            | "byte"
            | "second"
            | "percent"
            | "bit_per_second"
            | "millisecond"
            | "KB"
            | "MB"
            | "GB";
    }[]

    The individual rules that make up the alert definition.

• service_type: string

  The identifier for the Akamai Cloud Computing service. Use this value to call out the service in other Monitor operations in the API.

• severity: 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.

• status: "enabled" | "disabled" | "in progress" | "failed"

  Filterable The current status of the alert. This can be either enabled, disabled, in progress, or failed.

• trigger_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.

  • criteria_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.

  • evaluation_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.

  • polling_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.

  • trigger_occurrences: number

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

• type: "user" | "system"

  Filterable The type of alert. This can be either user for an alert specific to the current user, or system for one that applies to all users on your account.

• updated: string

  When the alert definition was last updated. This is the same as created if the alert definition hasn't been updated.

• updated_by: string

  For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.