get_resource_metrics

ResourceMetricsApi.get_resource_metrics(role_id, id, resource_type, duration, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Retrieve metrics for a resource

Retrieves time-series metrics for a resource (currently datasets with metrics collection enabled). Response shape example - Message.ResourceMetrics[] with Label, Unit, and DataPoints [{Value, Timestamp}], e.g. FileCount/Count, TotalFileSize/Bytes, DatasetSize/Bytes (Value may be numeric or a size string like “420.17 KB”).

Parameters:

  • role_id (str) – User role id (required)

  • id (str) – Resource id (DatasetId for datasets) (required)

  • resource_type (str) – Resource type to fetch metrics for (required)

  • duration (str) – Number of days of metrics to retrieve (required)

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ResourceMetrics

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /metrics/{resource_type}/{id}

Success (HTTP 200)

Successfully retrieved resource metrics

Errors

HTTP 400

Invalid input

HTTP 500

Something went wrong at backend