Start License Check By Resource
Start a license check for a resource
{
"licenseCheckResources": [
{
"resourceInfo": {
"domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
"clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
"hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
},
"productInfo": {
"licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
"type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI",
"licensingMode": "One among: SUBSCRIPTION, PERPETUAL, MIXED",
"licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
"licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
"errorResponse": {
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
],
"referenceToken": "string"
}
],
"referenceToken": "string"
}
}
}
],
"forAllDomains": false
}A list of resources for which license check needs to be performed
Value that defines whether to get license check for all domains or not
Accepted
{
"id": "string",
"startTimestamp": "string",
"endTimestamp": "string",
"status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED",
"resourceLicensingInfos": [
{
"resourceInfo": {
"domainId": "f0bf0f65-f719-4c2d-980a-29a9094045b5",
"clusterId": "a0bf0f65-f719-4c2d-980a-29a9094045b5",
"hostId": "b0bf0f65-f719-4c2d-980a-29a9094045b5"
},
"productInfo": {
"licenseKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
"type": "One among: VCENTER, NSXT, VSAN, WCP, ESXI",
"licensingMode": "One among: SUBSCRIPTION, PERPETUAL, MIXED",
"licenseKeyStatus": "One among: EXPIRED, ACTIVE, NEVER_EXPIRES",
"licenseKeyExpirationDate": "2021-04-08T04:37:51.662Z",
"errorResponse": {
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string"
}
}
}
]
}ID of the resources license check task
Task start timestamp
Task end timestamp
Task status
List of licensing infos of resources
Bad Request
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Internal server error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/resources/license-checks