Vasa Provider Query Replication Group

Query for the replication group details.

Required privileges: StorageViews.View

Request

URI

POST

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

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

QueryReplicationGroupRequestType of type(s) application/json

Required

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

array of ReplicationGroupId

groupId

Optional

List of replication group IDs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

An array of GroupOperationResult elements.

If the input array is null or empty, VASA Provider needs to return all available replication groups. Depending on the number of replication groups to be returned, VASA Provider can return either a list of GroupOperationResult or a list of QueryReplicationGroupSuccessResult. However, VASA Provider should not return a hybrid result.

If the input array is not empty, VASA Provider needs to return an array of results, one for each entry in the input. Each entry in the returned array is either a QueryReplicationGroupSuccessResult (for success), or a GroupErrorResult (for failure). The length of the result arrays must be the same as the input.

The fault in the result entry can be set to:

NotFound if the replication group identifier is not present.
DuplicateEntry if the replication group 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 GroupOperationResult of type(s) application/json

[
    {
        "_typeName": "string",
        "groupId": {
            "_typeName": "string",
            "faultDomainId": {
                "_typeName": "string",
                "id": "string"
            },
            "deviceGroupId": {
                "_typeName": "string",
                "id": "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 replication groups.

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