Get Resources License Check Result

Get the result of the resources license check

Request

URI

GET

https://sfo-vcf01.rainpole.io/v1/resources/license-checks/{id}

COPY

Path Parameters

string

Required

The resources license check ID

Responses

200

Successful

Returns ResourcesLicenseCheckResult of type(s) */*

{
    "endTimestamp": "string",
    "id": "string",
    "resourceLicensingInfos": [
        {
            "productInfo": {
                "errorResponse": {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "context": {
                        "context": "string"
                    },
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                },
                "licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
                "licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
                "licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
                "licensingMode": "One among: SUBSCRIPTION, PERPETUAL",
                "type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI"
            },
            "resourceInfo": {
                "clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
                "domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
                "hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
            }
        }
    ],
    "startTimestamp": "string",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED"
}

string

endTimestamp

Optional

Task end timestamp

string

Optional

ID of the resources license check task

array of ResourceLicensingInfo

resourceLicensingInfos

Optional

List of licensing infos of resources

string

startTimestamp

Optional

Task start timestamp

string

status

Optional

Task status

400

Bad Request

Returns Error of type(s) */*

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

string

message

Optional

The localized error message

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

remediationMessage

Optional

The localized remediation error message

500

Internal server error

Returns Error of type(s) */*

{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}

array of string

arguments

Optional

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

array of ErrorCause

causes

Optional

The underlying cause exceptions.

object

context

Optional

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