monitor_services_alert_definition_info.md

monitor_services_alert_definition_info

Get info about a Linode Alert Definition.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- linode.cloud.monitor_services_alert_definition_info:
    service_type: 'dbaas'
    id: 12345
    api_version: v4beta

Parameters

Field	Type	Required	Description
service_type	str	Required	The ID of the Service Type for this resource.
id	int	Required	The ID of the Alert Definition to resolve.

Return Values

• alert_definition - The returned Alert Definition.

  • Sample Response:

    {
      "id": 12345,
      "label": "Test Alert for DBAAS",
      "service_type": "dbaas",
      "severity": 1,
      "type": "user",
      "description": "A test alert for dbaas service",
      "scope": "entity",
      "regions": [],
      "group_by": [
        "entity_id"
      ],
      "entities": {
        "url": "/monitor/services/dbaas/alert-definitions/12345/entities",
        "count": 1,
        "has_more_resources": false
      },
      "alert_channels": [
        {
          "id": 10000,
          "label": "Read-Write Channel",
          "type": "email",
          "url": "/monitor/alert-channels/10000"
        }
      ],
      "rule_criteria": {
        "rules": [
          {
            "aggregate_function": "avg",
            "dimension_filters": [
              {
                "dimension_label": "node_type",
                "label": "Node Type",
                "operator": "eq",
                "value": "primary"
              }
            ],
            "label": "High CPU Usage",
            "metric": "cpu_usage",
            "operator": "gt",
            "threshold": 90,
            "unit": "percent"
          }
        ]
      },
      "trigger_conditions": {
        "criteria_condition": "ALL",
        "evaluation_period_seconds": 300,
        "polling_interval_seconds": 60,
        "trigger_occurrences": 3
      },
      "class": "alert",
      "status": "active",
      "created": "2024-01-01T00:00:00",
      "updated": "2024-01-01T00:00:00",
      "updated_by": "tester"
    }

  • See the Linode API response documentation for a list of returned fields