monitoring.alarms.update

Change an alarm; changing what it measures resets it to INSUFFICIENT_DATA

PUT /monitoring/api/alarms/{id}IAM monitoring:PutMetricAlarmChanges stateDestructive

Request syntax

PUT /monitoring/api/alarms/{id}
{
  "name": "string",
  "resourceType": "enum",
  "resourceId": "string",
  "metric": "string",
  "dimensions": "map of string",
  "statistic": "enum",
  "comparator": "enum",
  "threshold": "number",
  "periodSeconds": "number",
  "evaluationPeriods": "number",
  "notifyEmails": "array of string",
  "webhookUrl": "string",
  "enabled": "boolean"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • nameOptional

    string

    Unique in the organization (409 when taken): 1–128 characters, no control characters; unchanged when omitted

  • resourceTypeOptional

    enum

    instance, db_node, vpn_connection, eks_cluster, cdn_distribution, app, or custom: a series the organization publishes itself; unchanged when omitted. Changing it without dimensions leaves the alarm with none

    One of: instance, db_node, vpn_connection, eks_cluster, cdn_distribution, app, custom

  • resourceIdOptional

    string

    The resource’s id as resources lists it, 1–64 letters, digits and dashes; 404 when the organization has no such resource. For custom, the series’ namespace (up to 255 characters; the series need not exist yet); unchanged when omitted

  • metricOptional

    string

    One of cpu_percent, disk_read_iops, disk_write_iops, disk_read_bps, disk_write_bps, network_in_bps, network_out_bps, disk_used_percent, connections, replication_lag_bytes, query_slowdown, docdb_up, tunnel_up, tunnel_in_bps, tunnel_out_bps, bgp_prefixes, api_available, control_plane_ready, nodes_ready, nodes_not_ready, cdn_requests, cdn_cache_hits, cdn_cache_misses, cdn_hit_ratio, cdn_bytes_out, cdn_origin_bytes, waf_blocked, waf_counted, waf_challenged, waf_rate_limited, deploy_duration_seconds, deploys_succeeded, deploys_failed, and one the resource type records (400 otherwise); for custom, the series’ metric name; unchanged when omitted

  • dimensionsOptional

    map of string

    custom only: the series’ dimensions, replacing them; unchanged when omitted

    Constraints: key=value

    May be null.

  • statisticOptional

    enum

    avg, max, min, sum or count; unchanged when omitted

    One of: avg, max, min, sum, count

  • comparatorOptional

    enum

    >, >=, < or <=; unchanged when omitted

    One of: >, >=, <, <=

  • thresholdOptional

    number

    The value the statistic is compared with, in the metric’s unit; unchanged when omitted

  • periodSecondsOptional

    number

    Seconds per evaluated period, a whole number of minutes from 60 to 86400. period × evaluationPeriods may be at most one day; unchanged when omitted

    Constraints: integer

  • evaluationPeriodsOptional

    number

    How many periods in a row are evaluated, 1–100; ALARM when every one breaches; unchanged when omitted

    Constraints: integer

  • notifyEmailsOptional

    array of string

    Up to 10 addresses, mailed on entering and on leaving ALARM; replaces the list, unchanged when omitted

  • webhookUrlOptional

    string

    An https URL on a public address, up to 2048 characters, POSTed on entering and on leaving ALARM; null removes it, unchanged when omitted

    May be null.

  • enabledOptional

    boolean

    Whether a state change notifies anyone; the alarm is evaluated and its state kept either way; unchanged when omitted

Response

200 with the alarm as get describes it. The merged rule is checked as a whole: 400 when it no longer fits (look-back over a day, a built-in metric the resource does not record), 404 when the alarm or a new resource does not exist, 409 when the new name is taken.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow monitoring:PutMetricAlarm on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud monitoring alarms update id

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