monitoring.custom-metrics.get-data

Datapoints of one custom series, one per period

GET /monitoring/api/custom-metrics/dataIAM monitoring:GetMetricDataRead

Ranges older than 15 days, or periods of whole hours, are read from hourly rows and the period is rounded up to an hour.

Request syntax

GET /monitoring/api/custom-metrics/data

Query parameters

  • seriesIdRequired

    string

    From custom-metrics list

    Constraints: uuid

  • startRequired

    string

    ISO 8601

  • endOptional

    string

    ISO 8601; now when left out

  • periodOptional

    number

    Seconds, a whole number of minutes, default 60; at most 1440 points

    Constraints: integer

  • statisticOptional

    enum

    avg (default), sum, min, max or count

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

Response

200 with { series, start, end, period, statistic, points }: series as custom-metrics list describes it, period as actually used (rounded up to an hour on the hourly rows) and points as { ts, value }. 404 when the organization has no such series; 400 past 1440 points.

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:GetMetricData 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 custom-metrics get-data --series-id 00000000-0000-0000-0000-000000000000 --start example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_monitoring_custom-metrics_get-data.