Sms Storage Manager Query Associated Backing Storage Pool

Query Backing Storage Pools for StorageLun or StorageFileSystem.

Required privileges: StorageViews.View

Request

URI

POST

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

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

QueryAssociatedBackingStoragePoolRequestType of type(s) application/json

Required

{
    "entityId": "string",
    "entityType": "string"
}

string

entityId

Optional

Unique identifier of a StorageLun or StorageFileSystem.

string

entityType

Optional

Entity type of the entity specified using entityId. This can be either StorageLun or StorageFileSystem.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Array of BackingStoragePoolBackingStoragePool associated with specified StorageLun or StorageFileSystem. If entityId is null then API returns all the BackingStoragePools of the specified type. If both entityId and entityType are not specified then API returns all the BackingStoragePools available.

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

[
    {
        "_typeName": "string",
        "uuid": "string",
        "type": "string",
        "capacityInMB": 0,
        "usedSpaceInMB": 0
    }
]

500

NotFound: if the specified entityId 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