Skip to main content
 print this page

Retrieve cluster operation details

GET 
/clusters/:clustertype/:operations

Returns operation-specific cluster details for the given clustertype and operations.

Supported dwh operations:

  • groups — list Redshift roles (Roles)
  • metrics — cluster CloudWatch metrics
  • queries — query execution details or result rows; requires queryId; set action=results for output
  • queries-loads — query and load history; requires startTime and endTime
  • schemas — list schemas in a tenant database, or tables when schema_name is provided
  • system-tables — list available Redshift system table names
  • tenants — list tenants, or return one tenant when TenantName is provided (tenancy required)
  • user-access — whether catalog table-view access is enabled
  • wlm — workload management queues (provisioned only; serverless returns 400 N/A)

Supported os operations:

  • indexhistory — catalog index history. Returns a bare JSON array, not an object, capped at the 3 most recent entries with no pagination.
  • metrics — OpenSearch metrics, wrapped under Clusters exactly like the dwh metrics response.

Supported rag operations:

  • metrics — RAG cluster metrics.

Response shapes differ by clustertype — read this before writing a client. The dwh and os metrics responses nest their payload under a Clusters key, whereas the rag metrics response is returned flat at the top level with no wrapper. indexhistory is different again: a bare array. A client written against one clustertype will not work against another unchanged.

Note also that when RAG metrics collection fails, the body carries an Error property with an empty Metrics object rather than the metric data. Inspect for that property before reading Metrics.

Request​

Responses​

Successful API response.

Response Headers
    Access-Control-Allow-Origin
    Access-Control-Allow-Methods
    Access-Control-Allow-Headers