Vslm V Storage Object Manager Vslm List V Storage Object For Spec

List virtual storage objects matching all the VslmVsoVStorageObjectQuerySpec.

The results are determined by ANDing the VslmVsoVStorageObjectQuerySpec while ORing each of the values specified as a part of the queryValue field. Currently, only a single value in queryValue is supported. Expect that not all results will be returned. If all results are not returned, allRecordsReturned flag will be set to false. Results will be returned in id order. To query for addtional objects, "add ID > last ID returned" to the query and call VslmListVStorageObjectForSpec again.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vslm/VslmVStorageObjectManager/{moId}/VslmListVStorageObjectForSpec

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

string

release

Required

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

Request Body

VslmListVStorageObjectForSpecRequestType of type(s) application/json

Required

Show optional properties

{
    "maxResult": 0
}

{
    "query": [
        {
            "_typeName": "string",
            "queryField": "string",
            "queryOperator": "string",
            "queryValue": [
                "string"
            ]
        }
    ],
    "maxResult": 0
}

array of VslmVsoVStorageObjectQuerySpec

query

Optional

Query defined using array of VslmVsoVStorageObjectQuerySpec objects.

integer As int32 As int32

maxResult

Required

Maximum number of virtual storage object IDs to return.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

VslmVsoVStorageObjectQueryResult array containing the list of IDs of the virtual storage objects sorted in ascending order and matching the query.

Returns VslmVsoVStorageObjectQueryResult of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "allRecordsReturned": false,
    "id": [
        {
            "_typeName": "string",
            "id": "string"
        }
    ],
    "queryResults": [
        {
            "_typeName": "string",
            "id": {
                "_typeName": "string",
                "id": "string"
            },
            "name": "string",
            "capacityInMB": 0,
            "createTime": "string",
            "datastoreUrl": "string",
            "diskPath": "string",
            "usedCapacityInMB": 0,
            "backingObjectId": {
                "_typeName": "string",
                "id": "string"
            },
            "snapshotInfo": [
                {
                    "_typeName": "string",
                    "backingObjectId": {
                        "_typeName": "string",
                        "id": "string"
                    },
                    "description": "string",
                    "snapshotId": {
                        "_typeName": "string",
                        "id": "string"
                    },
                    "diskPath": "string"
                }
            ],
            "metadata": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": "string"
                }
            ],
            "error": {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        }
    ]
}

boolean

allRecordsReturned

Required

If set to false, more results were found than could be returned (either limited by maxResult input argument in the VslmVStorageObjectManager.VslmListVStorageObjectForSpec API or truncated because the number of results exceeded the internal limit).

array of ID

Optional

IDs of the VStorageObjects matching the query criteria NOTE: This field will be removed once the dev/qe code is refactored.

IDs will be returned in ascending order. If VslmVsoVStorageObjectQueryResult.allRecordsReturned is set to false, to get the additional results, repeat the query with ID > last ID as part of the query spec VslmVsoVStorageObjectQuerySpec.

array of VslmVsoVStorageObjectResult

queryResults

Optional

Results of the query criteria.

IDs will be returned in ascending order. If VslmVsoVStorageObjectQueryResult.allRecordsReturned is set to false,then, to get the additional results, repeat the query with ID > last ID as part of the query spec VslmVsoVStorageObjectQuerySpec.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Storage Lifecycle Management Operations