Get Resource Warning

Get Resource Warning

Get a Resource Warning by ID

Request
URI
GET
https://{api_host}/v1/resource-warnings/{id}
COPY
Path Parameters
string
id
Required

id

Responses
200

OK

Returns ResourceWarning of type(s) application/json 
{
    "id": "string",
    "warningCode": "string",
    "message": "string",
    "remediationMessage": "string",
    "referenceToken": "string",
    "resourceId": "string",
    "resourceType": "One among: HOST, CLUSTER, DOMAIN",
    "resourceName": "string",
    "warningType": "One among: SKIPPED_RESOURCE, VALIDATION, CONFIGURATION, OTHER",
    "severity": "One among: MINOR, MAJOR",
    "occurredAtTimestamp": "string",
    "context": {
        "context": "string"
    },
    "associatedTask": {
        "taskId": "string",
        "subTaskId": "string"
    }
}
string
id
Optional

ID of the resource warning

string
warningCode
Optional

The warning code

string
message
Optional

The localized warning message

string
remediationMessage
Optional

The localized remediation warning message

string
referenceToken
Optional

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

string
resourceId
Optional

ID of the associated resource

string
resourceType
Optional

Type of the associated resource

string
resourceName
Optional

Name of the associated resource

string
warningType
Optional

Type of the warning

string
severity
Optional

Severity of the warning

string
occurredAtTimestamp
Required

Timestamp when the warning occurred

object
context
Optional

Optional additional context information in a key value form

AssociatedTask
associatedTask
Optional

Task association for a resource warning. Indicates in which task the resource warning occurred


404

Resource Warning not found

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


500

Internal Server Error

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


On This Page
Resource Warnings Operations
POST
Create Resource Warning
GET
Get Resource Warning
GET
Get Resource Warnings