monitoring.alarms.get

Describe one alarm and its current state

GET /monitoring/api/alarms/{id}IAM monitoring:DescribeAlarmsRead

Request syntax

GET /monitoring/api/alarms/{id}

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

200 with the alarm: id, name, resourceType, resourceId, metric, dimensions, statistic, comparator, threshold, periodSeconds, evaluationPeriods, state (OK, ALARM or INSUFFICIENT_DATA), stateReason, stateChangedAt, notifyEmails, webhookUrl, enabled, ownerType and ownerId (set on an alarm the platform made for a resource), createdAt, updatedAt. 404 both for an alarm that does not exist and for one the caller may not describe.

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 get 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_get.