Check Content Supervisor Services
Perform validation checks on the content of a Supervisor Service version defined in the spec. The operation returns the validation status and relevant Supervisor Service version information that are available in the content. A custom format will always return a VALID status. Only vSphere and Carvel packages can return multiple validation statuses.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisor-services?action=checkContent
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NamespaceManagementSupervisorServicesCheckContentRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"content": "string"
}
}
spec
Required
Specification for the content to be checked.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NamespaceManagementSupervisorServicesCheckResult
of type application/json
A check result containing validation status and relevant Supervisor Service version information from the provided content, if the content is valid. In case of invalid content, it will return a list of error messages.
{
"carvel_apps_check_result": {
"description": "string",
"display_name": "string",
"supervisor_service": "string",
"version": "string"
},
"content_type": "VSPHERE_APPS_YAML",
"error_messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"status": "VALID",
"vsphere_apps_check_result": {
"description": "string",
"display_name": "string",
"eula": "string",
"supervisor_service": "string",
"version": "string"
},
"warning_messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
status
Required
The SupervisorServices.ValidationStatus enumerated type defines the type of status for validating content of a Supervisor Service version.
VALID : Indicates the content is valid for a Supervisor Service version.
VALID_WITH_WARNINGS : Indicates the content is valid for a Supervisor Service version, but the content may contain information that should be reviewed closely and could prevent the Supervisor Service version to be created successfully later, which is explained in SupervisorServices.CheckResult.warning-messages. For example, the content may specify a Supervisor Service version that already exists on this vCenter.
INVALID : Indicates the content is invalid for a Supervisor Service version, in which case the reasons can be found in SupervisorServices.CheckResult.error-messages.
Possible values are: VALID , VALID_WITH_WARNINGS , INVALID
carvel_apps_check_result
Optional
The information about the Supervisor Service version retrieved from the provided content as a result of validation checks if the content is in the Carvel application format. If unset, the content is not in the Carvel application package format, or the SupervisorServices.CheckResult.status is INVALID.
content_type
Optional
The Versions.ContentType enumerated type defines the type of content that describes the format of Supervisor Service version definition.
VSPHERE_APPS_YAML : The Supervisor Service version definition is provided as inline YAML document that follows the vSphere application service format.
CARVEL_APPS_YAML : The Supervisor Service version definition is provided as inline YAML document that follows the Carvel application package format.
CUSTOM_YAML : The Supervisor Service version definition is provided as inline YAML document that follows a plain Kubernetes YAML format.
Possible values are: VSPHERE_APPS_YAML , CARVEL_APPS_YAML , CUSTOM_YAML
array of
StdLocalizableMessage
error_messages
Optional
A list of messages indicating why the content was considered invalid. This field is optional and it is only relevant when the value of SupervisorServices.CheckResult.status is INVALID.
vsphere_apps_check_result
Optional
The information about the Supervisor Service version retrieved from the provided content as a result of validation checks if the content is in the vSphere application format. If unset, the content is not in the vSphere application service format, or the SupervisorServices.CheckResult.status is INVALID.
array of
StdLocalizableMessage
warning_messages
Optional
A list of messages indicating why the content was considered valid but contains information that should be reviewed closely. This field is optional and it is only relevant when the value of SupervisorServices.CheckResult.status is VALID_WITH_WARNINGS.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the provided spec is invalid. For example, the provided SupervisorServices.ContentCheckSpec.content is empty or not base64 encoded.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementSupervisorServicesContentCheckSpec = Initialize-NamespaceManagementSupervisorServicesContentCheckSpec -Content "MyContent"
$NamespaceManagementSupervisorServicesCheckContentRequestBody = Initialize-NamespaceManagementSupervisorServicesCheckContentRequestBody -Spec $NamespaceManagementSupervisorServicesContentCheckSpec
Invoke-CheckContentNamespaceManagementSupervisorServices -NamespaceManagementSupervisorServicesCheckContentRequestBody $NamespaceManagementSupervisorServicesCheckContentRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"content":"string"}}' https://{api_host}/api/vcenter/namespace-management/supervisor-services?action=checkContent
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: check_content
Availability
Added in 7.0.3.0
