This API has a deprecated equivalent from v7.0U1.
List Item Storage
DescriptionLists all storage items for a given library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.
Request
URLURL
https://{api_host}/api/content/library/item/{library_item_id}/storage
Path Parameters
Path Parameters
string
library_item_id
Required
Identifier of the library item whose storage information should be listed.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
array of
LibraryItemStorageInfo of type application/json
The list of all storage items for a given library item.
{
"cached": false,
"checksum_info": {
"algorithm": "enum",
"checksum": "string"
},
"name": "string",
"size": 0,
"storage_backing": {
"datastore_id": "string",
"storage_uri": "string",
"type": "enum"
},
"storage_policy_id": "string",
"storage_uris": [
"string"
],
"version": "string"
}
boolean
cached
Required
Indicates whether the file is on disk or not.
string
version
Required
The version of this file; incremented when a new copy of the file is uploaded.
string
name
Required
The name of the file. This value will be unique within the library item for each file. It cannot be an empty string.
integer
size
Required
The file size, in bytes. The file size is the storage used and not the uploaded or provisioned size. For example, when uploading a disk to a datastore, the amount of storage that the disk consumes may be different from the disk file size. When the file is not cached, the size is 0.
storage_backing
Required
The storage backing on which this object resides. This might not be the same as the default storage backing associated with the library.
array of
string
storage_uris
Required
URIs that identify the file on the storage backing. These URIs may be specific to the backing and may need interpretation by the client. A client that understands a URI scheme in this list may use that URI to directly access the file on the storage backing. This can provide high-performance support for file manipulation.
string
storage_policy_id
Optional
Identifier of the storage policy associated with the file. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. This field will be unset if the file is located on a storage backing of type OTHER (because storage policies are not applicable for those backings) or if the file is located on a storage backing of type DATASTORE and Storage.Info.storage-policy-id is unset. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.spbm.StorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.spbm.StorageProfile.
checksum_info
Optional
A checksum for validating the content of the file. This value can be used to verify that a transfer was completed without errors.
A checksum cannot always be calculated, and the value will be unset if the file does not have content.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/item/{library_item_id}/storage
Errors
Availability
Added in 7.0U2
On This Page
Item Storage Operations
get
