Sms Storage Manager Query Fault Domain

Query for fault domains based on the query spec.

If spec is null, SMS will return all the root fault domains only.

Required privileges: StorageViews.View

Request

URI

POST

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

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

QueryFaultDomainRequestType of type(s) application/json

Required

{
    "filter": {
        "_typeName": "string",
        "providerId": "string"
    }
}

FaultDomainFilter

filter

Optional

This spec contains information needed for QueryFaultDomain 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

all the fault domains based on the query spec.

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

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

500

InvalidArgument: if invalid input is provided.

NotFound: if the specified providerId in the spec does not exist

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