Sms Storage Manager Query Replication Group Info

Query for replication group details based on the query filter spec.

The replication group id list in the filter spec cannot be null or empty.

Required privileges: StorageViews.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/sms/SmsStorageManager/{moId}/QueryReplicationGroupInfo

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 SmsStorageManager/{moId}.

string

release

Required

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

Request Body

QueryReplicationGroupInfoRequestType of type(s) application/json

Required

Show optional properties

{
    "rgFilter": {}
}

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

ReplicationGroupFilter

rgFilter

Required

This spec contains information needed for QueryReplicationGroupInfo API to filter the result.

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. The length of the result array must be the same as the input. In the result array, each entry is either a QueryReplicationGroupSuccessResult (for success), or a GroupErrorResult (for failure).

The following fault may be set in error result entry:

NotFound if the replication group cannot be found.
ProviderUnavailable if the provider for the entity is temporarily unavailable.
InactiveProvider if the provider for the entity is not active.
ProviderBusy if the provider for the entity is busy.
NotImplemented if the provider does not implement this function.

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.

ServiceNotInitialized: if SMS service is not initialized.

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

Returns QueryExecutionFault of type(s) application/json

This response body class contains all of the following: MethodFault

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Monitoring Service Operations