Clone an alert definition

Limited availability Clone an existing alert definition, for a specific service type. Run the List alert definitions operation to see all of your available definitions. These points apply to cloning:

  • You need to set a new label for the clone.

  • You can clone your custom user alert definitions and preset Akamai system alert definition. Cloning a system alert definition generates a user alert definition.

  • Leave out optional fields from the request to keep existing settings from the clone source. If you include a field that allows you to apply multiple values, you need to include any existing values to keep them. Run the Get an alert definition operation to see the current settings for your source. If you leave an existing value out, it's removed from the clone.

  • You can't change the scope for a cloned alert definition:

    • If the clone source scope is region, you can modify the region array to add or remove new regions. Leave this array out to create a new alert definition in the same regions.

    • If the clone source scope is entity, you can add new entity_ids to include additional entities. To remove current entities, leave their entity_id out.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: monitor:read_write

CLI

linode-cli alerts definition-clone dbaas 457 \
--label Read-Write Channel (clone)
--description New alert definition cloned from Read-Write Channel
--regions us-iad

Learn more

Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
string
required

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.

integer
required

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

Body Params

The fields used to clone an alert definition if it was created with a scope of account.

channel_ids
array of integers

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

channel_ids
string

An additional description for the alert definition.

group_by
array of strings

Aggregates metric data by dimension so that alert conditions are evaluated independently for each dimension value. For example, if you group CPU usage by node type, CPU usage is evaluated separately for each node type, instead of evaluating all node types together. This array supports these values:

  • entity_id. Include this by name to group the alerts using the entity_id.

  • dimension_label. This represents the desired dimension from a monitoring metric. To get a dimension_label, run the List metrics for a service type operation, review the available dimensions, and store the applicable dimension_label values.

The entity_id is required if you include any dimension_label, to specify the service that the dimension_label belongs to. If you leave group_by out the request, the alert definition is evaluated and grouped by the entity_id.

📘

The entity_id is not mandatory if the service_type is objectstorage.

group_by
string
required

Set a new, unique name for the alert definition clone. This is used for display purposes in Akamai Cloud Manager.

rule_criteria
object

Details for the rules required to trigger the alert.

integer
enum

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

Allowed:
trigger_conditions
object

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

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json