NAnasuni
Volumes

Get Volume Details

Get enriched volume details with per-edge state

Args: volume_id: The ID of the volume to retrieve details for

Returns: VolumeDetailsDto: The volume with per-edge state and configuration

get/volumes/{volume_id}/details

Request

Path parameters

volume_idstring required

Response

Volume details retrieved successfully

volume_idstring required
volume_namestring nullable
cloud_regionstring nullable
used_capacitystring nullable
percent_capacity_usedinteger nullable
compression_percentinteger nullable
protocolProtocol[]
remote_access_enabledboolean nullable
cloud_provider'amazons3' | 'amazons3gov' | 'azure' | 'google' | 'googles3' | 'atmos' | 'ironmountain' | 'rackspace' | 'nirvanix' | 'synaptic' | 'castor' | 'delldx' | 'cloudone' | 'hp' | 'cleversafe' | 'vipr' | 'ibmcos' | 'hcp' | 's3_compatible'

Cloud provider identity as used by NOC (shortname).

bucketstring nullable
permission_policy'POSIX Mixed Mode' | 'UNIX/NFS Permissions Only Mode' | 'Unauthenticated Access Mode' | 'NTFS Compatible Mode' | 'NTFS Exclusive Mode' | 'NTFS Multiprotocol Mode'
security_mode'Publicly Available' | 'Active Directory' | 'LDAP Directory'
case_sensitiveboolean nullable
connection_permission'READONLY' | 'READWRITE' | 'Custom'
antiransom_enabledboolean nullable
antivirus_enabledboolean nullable
safe_delete_enabledboolean nullable
audit_enabledboolean nullable
audit_output_typestring nullable
snapshot_retentionstring nullable
encryption_keysstring[]
chunk_sizeinteger nullable
compressionboolean nullable
dedupeboolean nullable
volume_versionstring nullable
cloud_credential_namestring nullable
cloud_credential_hostnamestring nullable
cloud_credential_notestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.