Skip to main content

Retrieving the Data Source

This data source can be retrieved by only ID.
Retrieve by ID
To retrieve by ID, fill in only the id field:
A recording rule that writes the result of a MetricsQL expression evaluation.

Schema

Required

  • id (String) Identifier for the resource, unique for its resource type.

Read-Only

  • bucket (String) Bucket where the rule writes its resulting time series.
  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • expr (String) MetricsQL expression evaluated by the rule.
  • labels (Map of String) Labels associated with the resource.
  • metadata (Attributes) : Metadata associated with the recording rule.

    Inner value description

    Common resource metadata. (see below for nested schema)
  • name (String) Human readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • record (String) Name of the resulting time series.
  • record_labels (Map of String) Labels added to the resulting time series.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
  • status (Attributes) : Current status of the recording rule.

    Inner value description

    Current status of a recording rule. (see below for nested schema)
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

Nested Schema for metadata

Nested Schema for status