Validate Vasa Provider

Validate Vasa Provider

Validate VasaProvider input specification

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/vasa-providers/validations
COPY
Request Body

vasaProvider

VasaProvider of type(s) application/json
Required

Show optional properties

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

ID of the VASA Provider

string
name
Required

Name of the VASA Provider

array of StorageContainer
storageContainers
Required

List of storage containers associated with the VASA Provider

string
url
Required

URL of the VASA Provider

array of VasaUser
users
Required

List of users associated with the VASA Provider

Responses
200

OK

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

additionalProperties

string
description
Optional

Description of the validation

string
executionStatus
Optional

Execution status of the validation

string
id
Optional

ID of the validation

string
resultStatus
Optional

Result status of the validation after it has completed its execution

array of ValidationCheck
validationChecks
Optional

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


202

Accepted

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

additionalProperties

string
description
Optional

Description of the validation

string
executionStatus
Optional

Execution status of the validation

string
id
Optional

ID of the validation

string
resultStatus
Optional

Result status of the validation after it has completed its execution

array of ValidationCheck
validationChecks
Optional

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


400

Bad Request

Returns Error of type(s) application/json 
{
    "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

Operation doesn't return any data structure

On This Page
Vasa Providers Operations
POST
Add Storage Containers To Vasa Provider
POST
Add Users To Vasa Provider
POST
Add Vasa Provider
DELETE
Delete Storage Container Of Vasa Provider
DELETE
Delete Vasa Provider
GET
Get Storage Containers Of Vasa Provider
GET
Get Users Of Vasa Provider
GET
Get Validation Of Vasa Provider
GET
Get Vasa Provider
GET
Get Vasa Providers
PATCH
Update Storage Container Of Vasa Provider
PATCH
Update User Of Vasa Provider
PATCH
Update Vasa Provider
POST
Validate Vasa Provider