Query Domain Image Compliance
Query image compliance in a Domain
Query image compliance in a Domain
Request
URI
POST
https://{api_host}/v1/domains/{domainId}/image-compliance/queries
COPY
Path Parameters
string
domainId
Required
Domain ID
Request Body
DomainImageComplianceQuerySpec
of type(s)
application/json
Required
{
"resources": [
{
"id": "string",
"type": "string"
}
]
}
array of
object
resources
Required
This specification contains parameters of resource, required to perform compliance check and transition
Responses
202
Accepted
Returns
DomainImageComplianceResponse
of type(s)
application/json
{
"queryInfo": {
"status": "string",
"queryId": "string",
"errorResponse": {
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
},
"failure": false,
"completed": false,
"processing": false
},
"result": {
"elements": [
{
"resource": {
"id": "string",
"type": "string",
"name": "string"
},
"timestamp": "string",
"status": "COMPLIANT, NON_COMPLIANT, INCOMPATIBLE, UNAVAILABLE, ERROR",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"image": {
"id": "string",
"name": "string"
},
"imageDetails": {
"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"
}
}
},
"imageComplianceDetails": [
{
"entityName": "string",
"componentType": "ADD_ON, BASE_IMAGE, COMPONENTS, HARDWARE_SUPPORT, SOLUTIONS",
"complianceStatus": "COMPLIANT, NON_COMPLIANT, INCOMPATIBLE, UNAVAILABLE, ERROR",
"severity": "ERROR, INFO, WARNING",
"componentCurrentVersion": "string",
"componentTargetVersion": "string",
"componentName": "string",
"componentVendor": "string",
"message": "string",
"impact": "string"
}
]
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
}
object
queryInfo
Optional
Represents the query info.
object
result
Optional
Represents a page of elements of a single type
404
Domain 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).
array of
object
notifications
Optional
Detailed results of the precheck validation.
string
message
Optional
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
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
429
Too many requests
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).
array of
object
notifications
Optional
Detailed results of the precheck validation.
string
message
Optional
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
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).
array of
object
notifications
Optional
Detailed results of the precheck validation.
string
message
Optional
The localized error message
string
remediationMessage
Optional
The localized remediation error message
array of
object
causes
Optional
The underlying cause exceptions.
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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"resources":["object"]}' https://{api_host}/v1/domains/{domainId}/image-compliance/queries
Domains Operations
GET
Get Tags Assigned To Domain
PUT
Assign Tags To Domain
DELETE
Remove Tags From Domain
GET
Get Domains
POST
Create Domain
PATCH
Update Domains
POST
Validate Domain Update Spec
POST
Perform Domain Isolation Precheck
POST
Query Domain Image Compliance
POST
Post Datastore Query
POST
Post Cluster Query
POST
Post Clusters Query
POST
Validate Domain Creation Spec
GET
Get Domain
DELETE
Delete Domain
PATCH
Update Domain
PATCH
Enable Overlay Over Management Network
Deprecated
GET
Get Domain Update Validation
GET
Get Domain Tag Manager Url
GET
Get Assignable Tags For Domain
GET
Get Domain Endpoints
GET
Get Domain Datacenters
GET
Get Domain Capabilities By Domain Id
GET
Get Domain Isolation Precheck Status
GET
Get Domain Image Compliance Query Response
GET
Get Datastore Query Response
GET
Get Datastores Criteria
GET
Get Datastore Criterion
GET
Get Cluster Query Response
GET
Get Clusters Query Response
GET
Get Cluster Criteria
GET
Get Cluster Criterion
GET
Domain Create Validation
GET
Get Tags Assigned To Domains
GET
Get Domain Capabilities