Get Cluster Image Compliance

Get Cluster Image Compliance

Get image compliance for a Cluster

Request
URI
GET
https://{api_host}/v1/clusters/{id}/image-compliance
COPY
Path Parameters
string
id
Required

Cluster Id


Responses
200

Ok

Returns ClusterImageCompliance of type(s) application/json
{
    "cluster": {
        "id": "string",
        "name": "string"
    },
    "clusterImage": {
        "id": "string",
        "name": "string"
    },
    "clusterImageDetails": {
        "baseImage": {
            "version": "7.0.0-0.0.30340198",
            "details": {
                "displayName": "7.0.0-0.0.30340198",
                "displayVersion": "string",
                "releaseDate": "string",
                "releaseTimestamp": "string",
                "quickPatchCompatibleVersions": [
                    {
                        "version": "8.0.3-0.0.23174786",
                        "displayVersion": "8.0 Update 3 - 23174786"
                    }
                ]
            }
        },
        "addOn": {
            "version": "2.0-1",
            "name": "DELL-sample-Addon",
            "vendor": "Dell",
            "displayName": "string",
            "displayVersion": "string"
        },
        "components": {
            "components": {
                "version": "1.3.2.8-1OEM.650.0.0.4598673",
                "details": {
                    "vendor": "intel",
                    "displayName": "string",
                    "displayVersion": "string"
                }
            }
        },
        "removedComponents": {
            "removedComponents": {
                "version": "1.3.2.8-1OEM.650.0.0.4598673",
                "details": {
                    "vendor": "intel",
                    "displayName": "string",
                    "displayVersion": "string"
                }
            }
        },
        "hardwareSupport": {
            "packages": {
                "packages": {
                    "pkg": "string",
                    "version": "string"
                }
            }
        },
        "alternativeImages": {
            "alternativeImages": {
                "baseImage": {
                    "version": "7.0.0-0.0.30340198",
                    "details": {
                        "displayName": "7.0.0-0.0.30340198",
                        "displayVersion": "string",
                        "releaseDate": "string",
                        "releaseTimestamp": "string",
                        "quickPatchCompatibleVersions": [
                            {
                                "version": "8.0.3-0.0.23174786",
                                "displayVersion": "8.0 Update 3 - 23174786"
                            }
                        ]
                    }
                },
                "addOn": {
                    "version": "2.0-1",
                    "name": "DELL-sample-Addon",
                    "vendor": "Dell",
                    "displayName": "string",
                    "displayVersion": "string"
                },
                "components": {
                    "components": {
                        "version": "1.3.2.8-1OEM.650.0.0.4598673",
                        "details": {
                            "vendor": "intel",
                            "displayName": "string",
                            "displayVersion": "string"
                        }
                    }
                },
                "removedComponents": {
                    "removedComponents": {
                        "version": "1.3.2.8-1OEM.650.0.0.4598673",
                        "details": {
                            "vendor": "intel",
                            "displayName": "string",
                            "displayVersion": "string"
                        }
                    }
                },
                "hardwareSupport": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "string"
                        }
                    }
                },
                "selectionCriteria": {
                    "selectionType": "One among: HOST_UUID, HOST_HARDWARE_SPEC",
                    "hostBiosIds": [
                        "string"
                    ],
                    "hostHardware": {
                        "vendor": "string",
                        "models": [
                            "string"
                        ],
                        "families": [
                            "string"
                        ],
                        "oemStrings": [
                            "string"
                        ]
                    }
                },
                "displayName": "string"
            }
        }
    },
    "status": "COMPLIANT, NON_COMPLIANT, INCOMPATIBLE, UNAVAILABLE",
    "imageComplianceDetails": [
        {
            "entityName": "string",
            "componentType": "ADD_ON, BASE_IMAGE, COMPONENTS, HARDWARE_SUPPORT, SOLUTIONS",
            "complianceStatus": "COMPLIANT, NON_COMPLIANT, INCOMPATIBLE, UNAVAILABLE",
            "severity": "ERROR, INFO, WARNING",
            "componentCurrentVersion": "string",
            "componentTargetVersion": "string",
            "componentName": "string",
            "componentVendor": "string",
            "message": "string",
            "impact": "string"
        }
    ],
    "timestamp": "string"
}
object
cluster
Optional

Represents a reference to the cluster

object
clusterImage
Optional

Represents a reference to the cluster image

object
clusterImageDetails
Optional

SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

string
status
Required

Cluster image compliance status

array of object
imageComplianceDetails
Required

Detailed results of cluster image compliance check

string
timestamp
Required

Update time for the cluster compliance, e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd'T'HH:mm:ss[.SSS]XXX ISO 8601 format


404

Cluster image compliance not found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/clusters/{id}/image-compliance