Vasa Provider Query Replication Peer

Query for the replication peer fault domains.

Required privileges: StorageViews.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/sms/VasaProvider/{moId}/QueryReplicationPeer

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VasaProvider/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

QueryReplicationPeerRequestType of type(s) application/json

Required

{
    "faultDomainId": [
        {
            "_typeName": "string",
            "id": "string"
        }
    ]
}

array of FaultDomainId

faultDomainId

Optional

An optional list of source fault domain ID.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

An array of QueryReplicationPeerResult.

If the input array is null or empty, VASA provider needs to return result for all available source FaultDomain(s). If the input array is not empty, VASA Provider needs to return one entry in result for each entry in the input. The length of the input and result arrays must be same in that case.

The fault in the result entry can be set to:

NotFound if the fault domain identifier is not present.
DuplicateEntry if the fault domain identifier is duplicate.
TooMany if the number of entries is too large to be returned in one call.
QueryExecutionFault for any other error.

Returns Array of QueryReplicationPeerResult of type(s) application/json

[
    {
        "_typeName": "string",
        "sourceDomain": {
            "_typeName": "string",
            "id": "string"
        },
        "targetDomain": [
            {
                "_typeName": "string",
                "id": "string"
            }
        ],
        "error": [
            {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        ],
        "warning": [
            {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        ]
    }
]

500

NotImplemented: if the provider does not implement this function.

ProviderUnavailable: if the provider is temporarily unavailable.

InactiveProvider: if the provider is inactive for the specified fault domains.

ProviderBusy: if the provider is busy and cannot process the request.

QueryExecutionFault: if an error is encountered while processing the query request.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters