OPopenshift
operators
installer

GET /v2/clusters/{cluster_id}/monitored-operators

Lists operators to be monitored for a cluster.

Request

  • Base URL
    http://api.openshift.com/api/assisted-install
  • URL
    http://api.openshift.com/api/assisted-install/v2/clusters/{cluster_id}/monitored-operators
  • Auth
    API key in header X-Secret-Key

Path parameters

cluster_idstring uuid required

The cluster to return operators for.

Query parameters

operator_namestring

An operator in the specified cluster to return its data.

Response

Success.

cluster_idstring uuid

The cluster that this operator is associated with.

namestring

Unique name of the operator.

versionstring

Operator version

namespacestring

Namespace where to deploy an operator. Only some operators require a namespace.

subscription_namestring

The name of the subscription of the operator.

operator_type'builtin' | 'olm'

Kind of operator. Different types are monitored by the service differently.

propertiesstring

Blob of operator-dependent parameters that are required for installation.

timeout_secondsinteger

Positive number represents a timeout in seconds for the operator to be available.

status'failed' | 'progressing' | 'available'

Represents the operator state.

status_infostring

Detailed information about the operator state.

status_updated_atstring date-time

Time at which the operator was last updated.

bundlesstring[]

List of identifier of the bundles associated with the operator. Can be empty.

dependency_onlyboolean

Whether the operator can't be installed without being required by another operator.

source_bundlesstring[]

IDs of the bundles this operator was selected through. Empty for standalone selections. An operator can belong to multiple bundles.

Changes

No recorded changes to this operation across all 54 revisions of this API.