monitoring.alarms.list

List alarms, those in ALARM first

GET /monitoring/api/alarmsIAM monitoring:DescribeAlarmsRead

Request syntax

GET /monitoring/api/alarms

Query parameters

  • resourceTypeOptional

    enum

    instance, db_node, vpn_connection, eks_cluster, cdn_distribution, app: as resources lists it. Filters only together with resourceId; custom alarms cannot be filtered

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

  • resourceIdOptional

    string

    The resource’s id as resources lists it (i-… for an instance, a uuid otherwise): 1–64 letters, digits and dashes. With resourceType, only that resource’s alarms, sorted by name; either one alone is ignored

Response

200 with the alarms as get describes them: ALARM first, then INSUFFICIENT_DATA, then OK, by name within each (by name only when filtered to one resource).

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:DescribeAlarms 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 list

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