Vasa Provider Query Point In Time Replica

Query for the point-in-time replicas available at the target location.

Required privileges: StorageViews.View

Request

URI

POST

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

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

QueryPointInTimeReplicaRequestType of type(s) application/json

Required

{
    "groupId": [
        {
            "_typeName": "string",
            "faultDomainId": {
                "_typeName": "string",
                "id": "string"
            },
            "deviceGroupId": {
                "_typeName": "string",
                "id": "string"
            }
        }
    ],
    "queryParam": {
        "_typeName": "string",
        "replicaTimeQueryParam": {
            "_typeName": "string",
            "fromDate": "string",
            "toDate": "string",
            "number": 0
        },
        "pitName": "string",
        "tags": [
            "string"
        ],
        "preferDetails": false
    }
}

array of ReplicationGroupId

groupId

Optional

List of replication group IDs.

QueryPointInTimeReplicaParam

queryParam

Optional

Describes the search criteria for the PiT query.

If none of the fields is set, or if the number of PiT replicas is too large, VASA provider can return QueryPointInTimeReplicaSummaryResult.

This structure may be used only with operations rendered under /sms.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

An array of GroupOperationResult elements.

Each of these elements is either GroupErrorResult or QueryPointInTimeReplicaSuccessResult or QueryPointInTimeReplicaSummaryResult for CDP capable replicators.

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

InvalidArgument: if groupId is null or empty, or queryParam is invalid.

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