REST API - get

content library item storage: get

Retrieves the storage information for a specific file in a library item.

Request:

HTTP request

POST https://{server}/rest/com/vmware/content/library/item/storage/id:{library_item_id}?~action=get

Path Parameters

Name	Type	Description
Required
library_item_id	string	Identifier of the library item whose storage information should be retrieved.

Request Body Structure:

{
"file_name" : "string"
}

Request Body Parameters:

Name	Type	Description
bold = required
file_name	string	Name of the file for which the storage information should be listed.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "storage_policy_id" : "obj-103",
            "checksum_info" : {
                "checksum" : "string",
                "algorithm" : "SHA1"
            },
            "size" : 1,
            "storage_uris" : [
                "http://myurl.com",
                "http://myurl.com"
            ],
            "cached" : true,
            "name" : "string",
            "storage_backing" : {
                "datastore_id" : "obj-103",
                "storage_uri" : "http://myurl.com",
                "type" : "DATASTORE"
            },
            "version" : "string"
        },
        {
            "storage_policy_id" : "obj-103",
            "checksum_info" : {
                "checksum" : "string",
                "algorithm" : "SHA1"
            },
            "size" : 1,
            "storage_uris" : [
                "http://myurl.com",
                "http://myurl.com"
            ],
            "cached" : true,
            "name" : "string",
            "storage_backing" : {
                "datastore_id" : "obj-103",
                "storage_uri" : "http://myurl.com",
                "type" : "DATASTORE"
            },
            "version" : "string"
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	info[]	The array of all the storage items for the given file within the given library item.
value[].storage_backing	storage_backing	The storage backing on which this object resides. This might not be the same as the default storage backing associated with the library.
value[].storage_backing.type	string	Type (`DATASTORE`, `OTHER`) of content.library.storage_backing. Specifies the type of the content.library.storage_backing. Value is one of: DATASTORE: The content of the library will be stored on a datastore. These are vCenter Server managed datastores, and are logical containers that hide specifics of each storage device. Depending on the type of storage you use, datastores can be backed by the following file system formats: Virtual Machine File System (VMFS) Network File System (NFS) OTHER: The content of the library will be stored on a remote file system. Supports the following remote file systems: NFS (on vCenter Server Appliance) SMB (on vCenter Server Appliance and vCenter Server for Windows) Optional. This field must be provided for the `create` operation. It will always be present in the result of the `get` or `list` operations. It is not used for the `update` operation.
value[].storage_backing.datastore_id	string	Identifier of the datastore used to store the content in the library. Optional. It is only relevant when type has value DATASTORE. This field is optional and it is only relevant when the value of `type` is DATASTORE.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.
value[].storage_backing.storage_uri	URI	URI identifying the location used to store the content in the library. The following URI formats are supported: vSphere 6.5 nfs://server/path?version=4 (for vCenter Server Appliance only) - Specifies an NFS Version 4 server. nfs://server/path (for vCenter Server Appliance only) - Specifies an NFS Version 3 server. The nfs://server:/path format is also supported. smb://server/path - Specifies an SMB server or Windows share. vSphere 6.0 Update 1 nfs://server:/path (for vCenter Server Appliance only) file://unc-server/path (for vCenter Server for Windows only) file:///mount/point (for vCenter Server Appliance only) - Local file URIs are supported only when the path is a local mount point for an NFS file system. Use of file URIs is strongly discouraged. Instead, use an NFS URI to specify the remote file system. vSphere 6.0 nfs://server:/path (for vCenter Server Appliance only) file://unc-server/path (for vCenter Server for Windows only) file:///path - Local file URIs are supported but strongly discouraged because it may interfere with the performance of vCenter Server. Optional. It is only relevant when type has value OTHER. This field is optional and it is only relevant when the value of `type` is OTHER.
value[].storage_policy_id	string	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. Optional. 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 content.library.item.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`.

Errors:

HTTP Status Code	Type	Description
404	not_found	if the specified library item does not exist.