Skip to main content

Retrieve a volume using the ID

GET /fsx/volumes/{fileSystemId}/{volumeId}

Retrieves volume using the ID.

Parameters

Name Type In Required Description

fields

Expands

query

False

fileSystemId

string

path

True

volumeId

string

path

True

Error

Status: Default, Default response
Name Type Required Description

name

string

True

Volume name

uuid

string

True

Volume UUID

svmName

string

True

Volume SVM name

size

Capacity

True

usedSize

Capacity

True

junctionPath

string

True

The junction path at which this volume is mounted

volumeTotalInodes

integer

False

Total volume inodes size

volumeUsedInodes

integer

False

Used volume inodes size

mountPoint

string

False

Mount Point

compressionSpaceSaved

Capacity

True

deduplicationSpaceSaved

Capacity

True

thinProvisioning

boolean

True

Specifies whether thin provisioning is enabled

compression

boolean

True

Specifies whether compression is enabled

deduplication

boolean

True

Specifies whether deduplication is enabled

snapshotPolicy

string

True

The name of the snapshot policy

securityStyle

string

True

The type of the security style

exportPolicyInfo

NamedExportPolicyInfo

True

shareNames

array[string]

True

The share names for CIFS

shareInfo

array[CifsShareInfo]

True

The share names, permissions, and users for CIFS

parentVolumeName

string

True

Name of the parent flexible volume for the clone

rootVolume

boolean

True

Flag to indicate if the volume is a SVM root

state

string

True

Volume state

volumeType

string

True

Volume type

aggregateName

string

True

Aggregate name

parentSnapshot

string

False

The snapshot name the volume is based on

autoSizeMode

string

True

The operating mode of autosize

maxGrowSize

Capacity

True

providerVolumeType

string

False

Cloud provider volume type

cloneNames

array[string]

True

Names of cloned copies of the volume

moving

boolean

True

Specifies if the volume move process is in progress

primaryNoFailoverMountPoint

string

False

Primary mount point without failover

secondaryNoFailoverMountPoint

string

False

Secondary mount point without failover

capacityTier

string

False

Capacity tier

capacityTierUsedSize

Capacity

False

cifsShareAccessPoint

string

False

CIFS share access point

primaryCifsShareAccessPoint

string

False

Primary CIFS share access point

secondaryCifsShareAccessPoint

string

False

Secondary CIFS share access point

tieringPolicy

string

False

Tiering policy

tierInactiveUserData

Capacity

False

tierInactiveUserDataPercent

integer

False

Tier inactive user data percentage

comment

string

False

Volume comment

qosPolicyGroupName

string

False

Quality of service policy group name

snaplockType

string

False

SnapLock type

constituentsAggregates

array[string]

True

Aggregates which are used for FlexGroup constituents

snapshotsUsedSize

Capacity

False

cbsBackupsInfo

VolumeCbsInfo

False

minimumCoolingDays

integer

False

Tiering minimum cooling days

targetName

string

True

iSCSI target IQN

iscsiEnabled

boolean

True

Indicates if the volume is used by the iSCSI protocol

isFlexGroupVolume

boolean

True

Indicates if the volume is a FlexGroup volume

Definitions

See Definitions

Expand

Name Type Required Description

name

string

False

Expands

Name Type Required Description

raw

string

True

expands

array[Expand]

True

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

index

Export policy rule index

ExportPolicyRule

Name Type Required Description

index

index

False

Export policy rule index

ruleAccessControl

string

True

Export policy rule access control

ips

array[string]

True

Export policy rule list of IPs

nfsVersion

array[string]

False

Export policy rule protocol

superUser

boolean

True

Export policy rule super user access

NamedExportPolicyInfo

Name Type Required Description

name

string

False

Export policy name

policyType

string

True

Export policy type

ips

array[string]

True

Custom export policy list of IPs

nfsVersion

array[string]

False

Export policy protocol

rules

array[ExportPolicyRule]

True

Export policy rules

CifsShareUserPermissions

Name Type Required Description

permission

string

False

CIFS share permission type

users

array[string]

True

List of users with the permission

CifsShareInfo

Name Type Required Description

shareName

string

True

Share name

accessControlList

array[CifsShareUserPermissions]

True

List of CIFS share permissions

vscanFileOpPolicy

string

False

Vscan file operations profile

VolumeCbsInfo

Name Type Required Description

totalBackups

integer

False