Skip to main content

Cluster Usage

Show the number of cluster-hours used in your organization. Optionally filter by a specific cluster or aggregate by time-frame. The output of this command is stored in the result object for further querying.

Syntax​

cluster usage 
  [of cluster <cluster reference>]
  [from "<start>" [to "<end>"]]
  [by <time period>]
  [limit <limit> [offset <offset>]]

Parameters​

cluster reference​

String — Name of the cluster to show usage history for. Omit it for the summed usage across every cluster in your organization.

start​

String — ISO-8601 formatted string including the timezone, such as 2021-04-29T08:12:23Z. If the timezone is omitted, it will default to UTC. If the time and time zone portions are omitted, it will default to T00:00:00. The provided time must be before end, and it must be in the past.

Default: an amount of time before the current time that depends on time period — 24 hours for hour, one month for day, one year for month, and one decade for year.

end​

String — ISO-8601 formatted string including the timezone, such as 2021-04-29T08:12:23Z. If the timezone is omitted, it will default to UTC. If the time and time zone portions are omitted, it will default to T00:00:00. Default: the current time.

time period​

String — The unit of time to use when aggregating the data. Allowed values: year, month, day, hour. Default: month.

limit​

Integer — Maximum number of cluster usage results to show. Default: 1000.

offset​

Integer — Number of results to omit from the beginning of the query, allowing additional records to be queried. Default: 0.

Security​

To run the cluster usage command against an entire organization, the user must have organization admin permissions.

To run the cluster usage command against a specific cluster, the user must have cluster read permissions on the targeted cluster.