Update Vasa Provider

Update a VASA Provider

Request

URI

PATCH

https://sfo-vcf01.rainpole.io/v1/vasa-providers/{id}

COPY

Path Parameters

string

Required

VASA Provider ID

Request Body

VASA Provider update data

VasaProviderUpdateSpec of type(s) application/json

Required

{
    "name": "string",
    "url": "string"
}

string

name

Optional

Name of the VASA Provider

string

url

Optional

URL of the VASA Provider

Responses

200

Returns VasaProvider of type(s) application/json

{
    "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

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

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

404

VASA Provider not found

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

InternalServerError

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).