API Catalog and Documentation
Insights Advisor for OpenShift V2
Insights Results Aggregator 2.0.0
Operations
Schemas
Insights Results Aggregator 2.0.0
Aggregation service for the results of running Insights rules.
Operations
Lists acks from this account where the rule is active
GET /ack
Acknowledges/hide the rule for given account
POST /ack
Deletes an acknowledgement for a rule
DELETE /ack/{rule_id}
AckGetEndpoint read the acknowledgement info about disabled rule
GET /ack/{rule_id}
Updates an acknowledgement for a rule, by rule ID.
PUT /ack/{rule_id}
Returns relevant information about the cluster available in AMS API.
GET /cluster/{clusterId}/info
Returns the latest report for the given cluster.
GET /cluster/{clusterId}/reports
Retrieve simplified reports for a given cluster and request IDs if available
GET /cluster/{clusterId}/request/{requestId}/report
Check status of a given cluster's request
GET /cluster/{clusterId}/request/{requestId}/status
List of requests for given cluster
GET /cluster/{clusterId}/requests
Filtered list of stored requests for given cluster ID
POST /cluster/{clusterId}/requests
GET /cluster/{clusterId}/upgrade-risks-prediction
Returns a list of clusters, total number of hitting rules and a count of impacting rules by total risk.
GET /clusters
Get all static content
GET /content
Get all rule groups and their relevant information
GET /groups
Returns basic information about Smart Proxy, Insights Results Aggregator, and Content Service.
GET /info
Read all metrics exposed by this service
GET /metrics
Retrieve DVO namespaces and recommendation aggregations for the whole organization
GET /namespaces/dvo
Retrieve DVO recommendations for a single namespace + cluster combination.
GET /namespaces/dvo/{namespaceId}/cluster/{clusterId}
Returns the OpenAPI specification JSON.
GET /openapi.json
Send the new rating for a given rule
POST /rating
Returns a list recommendations and the number of clusters they're currently impacting.
GET /rule
Get content for the given ruleId, along with user-specific data such as rule rating, disabling, etc.
GET /rule/{ruleId}
Get all static content for the given ruleId.
GET /rule/{ruleId}/content
Returns a list of cluster where the given rule is active. Also returns a list of clusters, for which the rule has been disabled.
GET /rule/{rule_selector}/clusters_detail
Returns the prediction based on latest stats for the given list of clusters.
POST /upgrade-risks-prediction
Schemas
alert
object
clusterId
string
clusterList
array
clusterListResponse
object
dvoReportMeta
object
gatheringRequests
array
namespaceId
string
operator_condition
object
ratingSchema
object
recommendationList
array
recommendationListResponse
object
report
object
reportData
object
reportMeta
object
reportResponse
object
requestId
string
simplifiedReport
array
statusResponse
string
systemWideRuleDisable
object
systemWideRuleDisableList
object
upgradeRisksPrediction
object
upgradeRisksPredictors
object
Back to top