Validate Vasa Provider Spec

Validate Vasa Provider Spec

Validate VasaProvider input specification

Request
URI
POST
https://{api_host}/v1/vasa-providers/validations
COPY
Request Body
VasaProvider of type(s) application/json
Required

Show optional properties

{
    "name": "string",
    "url": "string",
    "storageContainers": [
        {
            "name": "string",
            "protocolType": "One among: ISCSI, FC, NFS"
        }
    ],
    "users": [
        {
            "username": "string",
            "password": "string"
        }
    ]
}
{
    "id": "string",
    "name": "string",
    "url": "string",
    "storageContainers": [
        {
            "id": "string",
            "name": "string",
            "protocolType": "One among: ISCSI, FC, NFS",
            "clusterId": "string"
        }
    ],
    "users": [
        {
            "id": "string",
            "username": "string",
            "password": "string"
        }
    ]
}
string
id
Optional

ID of the VASA Provider

string
name
Required

Name of the VASA Provider

string
url
Required

URL of the VASA Provider

array of StorageContainer
storageContainers
Required

List of storage containers associated with the VASA Provider

array of VasaUser
users
Required

List of users associated with the VASA Provider

Responses
202

Accepted

Returns Validation of type(s) application/json 
{
    "id": "string",
    "description": "string",
    "executionStatus": "COMPLETED",
    "resultStatus": "SUCCEEDED",
    "validationChecks": [
        {
            "description": "string",
            "severity": "One among: WARNING, ERROR, INFO",
            "resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
            "errorResponse": {
                "errorCode": "string",
                "errorType": "string",
                "arguments": [
                    "string"
                ],
                "context": {
                    "context": "string"
                },
                "message": "string",
                "remediationMessage": "string",
                "causes": [
                    {
                        "type": "string",
                        "message": "string"
                    }
                ],
                "nestedErrors": [
                    "Error Object"
                ],
                "referenceToken": "string"
            }
        }
    ],
    "additionalProperties": {
        "additionalProperties": "string"
    }
}
string
id
Required

ID of the validation

string
description
Required

Description of the validation

string
executionStatus
Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string
resultStatus
Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of ValidationCheck
validationChecks
Optional

List of one or more validation checks that are performed as part of the validation

object
additionalProperties
Optional

additionalProperties


400

Bad Request

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 Validation of type(s) application/json 
{
    "id": "string",
    "description": "string",
    "executionStatus": "COMPLETED",
    "resultStatus": "SUCCEEDED",
    "validationChecks": [
        {
            "description": "string",
            "severity": "One among: WARNING, ERROR, INFO",
            "resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
            "errorResponse": {
                "errorCode": "string",
                "errorType": "string",
                "arguments": [
                    "string"
                ],
                "context": {
                    "context": "string"
                },
                "message": "string",
                "remediationMessage": "string",
                "causes": [
                    {
                        "type": "string",
                        "message": "string"
                    }
                ],
                "nestedErrors": [
                    "Error Object"
                ],
                "referenceToken": "string"
            }
        }
    ],
    "additionalProperties": {
        "additionalProperties": "string"
    }
}
string
id
Required

ID of the validation

string
description
Required

Description of the validation

string
executionStatus
Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string
resultStatus
Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of ValidationCheck
validationChecks
Optional

List of one or more validation checks that are performed as part of the validation

object
additionalProperties
Optional

additionalProperties


On This Page
Vasa Providers Operations
POST
Add Vasa Provider
POST
Add Vasa Provider Storage Container
POST
Add Vasa Provider User
GET
Get Vasa Provider
GET
Get Vasa Providers
GET
Get Vasa Provider Storage Containers
GET
Get Vasa Provider User
GET
Get Vasa Provider Validation
DELETE
Remove Vasa Provider
DELETE
Remove Vasa Provider Storage Container
PATCH
Update Vasa Provider
PATCH
Update Vasa Provider Storage Container
PATCH
Update Vasa Provider User
POST
Validate Vasa Provider Spec