Get Persistent Disk

All the listed privileges are required -

Privileges	Description
UDD_VIEW	Caller should have permission to this privilege, to perform this operation.

Request

URI

GET

https://{api_host}/rest/inventory/v1/persistent-disks/{id}

COPY

Path Parameters

string

Required

Id of persistent disk

id example

8fdefa82-17e4-4367-b5b1-8d97e4fd5e56

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns PersistentDiskInfo of type(s) */*

{
    "access_group_id": "73560ad0-93d1-4a5b-bdf6-3fddc4b5fb1d",
    "capacity_mb": 2048,
    "datastore_id": "datastore-33",
    "datastore_name": "Datastore1",
    "desktop_pool_id": "ce910882-e6ef-447a-a88b-333abe0c9c8a",
    "desktop_pool_name": "sales-pool1",
    "id": "c1d5aec7-2126-3c55-aefa-11949003c9c2",
    "last_attached_time": 1621512686000,
    "machine_id": "0f9f20be-4fa5-47dc-bcf2-f4fb555c51d2",
    "machine_name": "machine1",
    "name": "virtual-disk.vmdk",
    "status": "IN_USE",
    "usage": "PRIMARY",
    "user_id": "S-1-5-21-1111111111-2222222222-3333333333-500",
    "user_name": "testuser",
    "vcenter_id": "b32e941f-f272-4a4b-9d78-21b4602ed33f"
}

string

access_group_id

Optional

ID of the access group of the persistent disk.
Supported Filters: 'Equals'.

integer As int64 As int64

capacity_mb

Optional

Capacity of the persistent disk in MB. This property can be used for sorting.

string

datastore_id

Optional

ID of the datastore containing the persistent disk.
Supported Filters: 'Equals'.

string

datastore_name

Optional

Name of the datastore containing the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

desktop_pool_id

Optional

ID of the desktop pool associated with the persistent disk.
Supported Filters: 'Equals'.

string

desktop_pool_name

Optional

Name of the desktop pool associated with the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

Optional

Unique identifier for this persistent disk.
Supported Filters: 'Equals'.

integer As int64 As int64

last_attached_time

Optional

If the persistent disk is detached, indicates when it was last attached to a machine or created from a virtual disk. This property can be used for sorting.

string

machine_id

Optional

ID of the machine the persistent disk is attached to.
Supported Filters: 'Equals'.

string

machine_name

Optional

Name of the machine the persistent disk is attached to.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

name

Optional

Name of the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

status

Optional

Status of the persistent disk.
Supported Filters: 'Equals'. This property can be used for sorting.

ARCHIVING: The persistent disk is being archived.
ATTACHING: The persistent disk is attaching to a virtual machine.
DELETING: The persistent disk is being deleted.
DETACHING: The persistent disk is being detached from a virtual machine.
IN_USE: This persistent disk is in use.
REPLACING: The persistent disk is being replaced.
UNATTACHED: The persistent disk is not in use and available to attach to a virtual machine.

Possible values are : ARCHIVING, ATTACHING, DELETING, DETACHING, IN_USE, REPLACING, UNATTACHED,

string

usage

Optional

Usage of the persistent disk.
Supported Filters: 'Equals'. This property can be used for sorting.

DELETING: This data disk is in the process of being deleted or archived.
PRIMARY: This data disk is attached to a Virtual Machine and the user profile is redirected to it.
SECONDARY: This data disk is attached to a Virtual Machine.
UNATTACHED: This data disk is not attached to a Virtual Machine.

Possible values are : DELETING, PRIMARY, SECONDARY, UNATTACHED,

string

user_id

Optional

SID of the user owning the persistent disk.
Supported Filters: 'Equals'.

string

user_name

Optional

Name of the user owning the persistent disk.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

vcenter_id

Optional