dcloud errors alert-rules update

Change an alert rule, or turn it on or off

IAM errors:PutAlertRuleChanges state

Synopsis

dcloud errors alert-rules update id ruleId [flags]

Arguments

  • <id>Required

    string

    Also accepted as --id. Constraints: uuid

  • <ruleId>Required

    string

    Also accepted as --rule-id. Constraints: uuid

Flags

  • --nameOptional

    string

    New name, 1–120 characters

    Constraints: 1-120 chars

  • --enabledOptional

    boolean (--enabled / --no-enabled)

    true turns the rule on, false off (kept without firing)

  • --triggerOptional

    object

    New trigger, replacing the old one. When the rule fires, by kind: {kind: "issue", events: ["new" | "regression" | "escalating", …]} (at least one); {kind: "frequency", events, windowMinutes} (an issue’s events in the window reach events, 1–10 000 000, window 1–1440 minutes); {kind: "users", users, windowMinutes} (an issue’s distinct users reach users); {kind: "crash_free", belowPercent, minSessions?} (a release’s crash-free sessions over the last hour fall below belowPercent, 1–99.99, with at least minSessions sessions, default 100); {kind: "dropped", events?, windowHours?, outcomes?} (what the project sent that was refused or lost after acceptance reaches events, 1–10 000 000, default 1, within the current hour and the windowHours − 1 before it, 1–24, default 1; outcomes "refused" and/or "lost", default both; the SDK’s own drops and profile milliseconds never count; filters do not apply)

    Constraints: JSON

  • --filtersOptional

    object

    New filters, replacing the old ones whole. Which issues the rule applies to; every filter given must match, an empty one matches all (none given on create: all empty): levels (fatal, error, warning, info, debug), environments (up to 20), tags (up to 10 {key, value}, matched against the issue’s latest event), titleContains (up to 200 characters)

    Constraints: JSON

  • --actionsOptional

    array of json

    New actions, replacing the old ones whole. What the rule does, 1–10 actions: {kind: "email", admins?, addresses?} (admins, default true, mails the organization’s owners and admins; up to 20 further addresses) or {kind: "webhook", url, format?} (an https URL, else 400; format auto (default, chosen by the URL’s host: Slack, Teams, Discord, else JSON), slack, teams, discord or json)

  • --throttle-minutesOptional

    number

    New quiet period, 1–10 080 minutes

    Constraints: integer, 1-10080

Example

dcloud errors alert-rules update id ruleId

Generated from the API description, the same one the API checks requests against and the CLI is built from.