Skip to main content

Retrieve a Cloud Volumes ONTAP system

GET /vsa/working-environments/{workingEnvironmentId}

Retrieves a Cloud Volumes ONTAP system.

Parameters

Name Type In Required Description

fields

Expands

query

False

workingEnvironmentId

string

path

True

Error

Status: Default, Default response
Name Type Required Description

actionsRequired

array[ActionRequired]

True

activeActions

array[string]

False

Actions currently being performed on this system

awsProperties

AwsProperties

False

capacityFeatures

CapacityFeatures

False

cbsProperties

CbsPropertiesWithReason

False

cloudProviderName

string

False

cloudSyncProperties

CloudSyncProperties

False

clusterProperties

VsaClusterProperties

False

complianceProperties

CloudComplianceStatusResponse

False

creatorUserEmail

string

False

cronJobSchedules

array[CronJobSchedule]

True

encryptionProperties

EncryptionProperties

False

fpolicyProperties

FpolicyProperties

False

haProperties

AwsHaProperties

False

interClusterLifs

array[InterClusterLif]

True

isHA

boolean

True

licensesInformation

array[LicenseInformation]

True

monitoringProperties

MonitoringStatusResponse

False

name

string

False

ontapClusterProperties

OntapClusterProperties

False

publicId

string

True

replicationProperties

ReplicationProperties

False

reservedSize

Capacity

False

saasProperties

CvoSaasProperties

False

schedules

array[VsaSchedule]

True

snapshotPolicies

array[SnapshotPolicy]

True

status

StatusProperties

False

supportRegistrationInformation

array[SupportRegistrationInformation]

True

supportRegistrationProperties

SupportRegistrationProperties

False

supportedFeatures

SupportedFeatures

False

svmName

string

False

svms

array[Svm]

True

tenantId

string

False

workingEnvironmentType

string

False

Definitions

See Definitions

Expand

Name Type Required Description

name

string

False

Expands

Name Type Required Description

expands

array[Expand]

True

raw

string

True

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

RaidInfoForEvAggregate

Name Type Required Description

diskSize

Capacity

True

numOfDisks

integer

True

Number of new disks needed for the RAID group

ElasticVolumeQuoteInfo

Name Type Required Description

addedCapacityToExistingEvDisks

Capacity

False

newRaidForEvInfo

array[RaidInfoForEvAggregate]

False

New RAID information

totalCapacityToAdd

Capacity

False

totalEvDisks

integer

False

InstanceNameIdAndType

Name Type Required Description

instanceId

string

False

instanceName

string

False

instanceType

string

False

OntapLicenseType

Name Type Required Description

capacityLimit

Capacity

True

capacity_limit

string

False

default

boolean

False

description

string

False

name

string

False

platformLicenseRequired

boolean

False

subDescription

string

False

subName

string

False

type

string

False

ChangeLicenseParameters

Name Type Required Description

newInstanceType

string

False

newLicenseType

OntapLicenseType

False

DisksDetails

Name Type Required Description

diskSize

Capacity

False

diskType

string

False

numberOfDisks

integer

False

ResourcesToDelete

Name Type Required Description

instanceNameAndType

array[InstanceNameIdAndType]

False

numberOfDisksAndDiskSize

array[DisksDetails]

False

VolumeInfo

Name Type Required Description

newCapacity

Capacity

False

svmName

string

False

volumeName

string

False

VolumeMoveParameters

Name Type Required Description

homeNode

string

False

isNewTargetAggregate

boolean

False

svmName

string

False

targetAggregateName

string

False

volumeName

string

False

ActionRequiredParameters

Name Type Required Description

aggregateName

string

True

Aggregate name

currentInstanceType

string

False

Current instance type

evCapacityDetails

ElasticVolumeQuoteInfo

False

instances

array[InstanceNameIdAndType]

True

Instances information

isCapacityBased

boolean

True

Indicates if the license type is a capacity-based license type

isComposite

boolean

True

Indicates if the aggregate is a composite aggregate

licenseExpiryDate

integer

True

License expiry date

licenseParameters

ChangeLicenseParameters

False

maxCapacity

Capacity

True

moreInfo

string

False

More information

numOfDisks

integer

True

Number of disks relevant to the action

providerVolumeType

string

False

Provider volume type

resourcesToDelete

ResourcesToDelete

False

serialNumber

string

True

Platform Serial number

totalCapacity

Capacity

True

volumeInfo

VolumeInfo

False

volumeMoveParameters

VolumeMoveParameters

False

volumeNames

array[string]

True

A limited list of volumes on the aggregate

workingEnvironmentId

string

True

System public ID

ActionRequired

Name Type Required Description

actionType

string

True

The type of the Action

parameters

ActionRequiredParameters

True

severity

string

True

Action Severity

bootDiskSize

coreDiskExists

tags

Instance tags

Hash mapping strings to string

Name Type Required Description

empty

boolean

False

traversableAgain

boolean

False

InstanceResponse

Name Type Required Description

availabilityZone

string

True

Availability zone

id

string

True

Instance ID

imageId

string

True

Image ID

instanceProfileId

string

False

Instance profile ID

instanceType

string

True

Instance type

isOCCMInstance

boolean

True

Indicates if the instance is a NetApp Console instance

isVsaInstance

boolean

True

Indicates if the instance is a Cloud Volumes ONTAP instance

keyPairName

string

True

Key pair

name

string

True

Instance name

placementGroup

string

True

Placement group

privateDnsName

string

True

Private DNS name

privateIpAddress

string

True

Private IP address that is assigned to the instance

productCode

string

True

Product code

publicDnsName

string

True

Public DNS

publicIpAddress

string

True

Public IP address that is assigned to the instance

state

string

True

Instance state

subnetId

string

True

Subnet ID

tags

tags

True

Instance tags

tenancy

string

True

Instance Tenancy

VpcTagResponse

Name Type Required Description

key

string

True

VPC tag key

value

string

True

VPC tag value

VpcBasicResponse

Name Type Required Description

cidrBlock

string

True

VPC Classless Inter-Domain Routing (CIDR) block

default

boolean

True

Indicates whether the VPC is the default

state

string

True

The state of the VPC

tags

array[VpcTagResponse]

True

VPC tags

vpcId

string

True

The VPC identifier

AwsProperties

Name Type Required Description

accountId

string

False

availabilityZones

array[string]

False

bootDiskSize

bootDiskSize

False

cloudProviderAccountId

string

False

coreDiskExists

coreDiskExists

False

instances

array[InstanceResponse]

False

outpostArn

string

False

regionName

string

False

roleArn

string

False

vpc

VpcBasicResponse

False

iops

DefaultProviderVolume

Name Type Required Description

capacityTier

string

False

diskType

string

False

iops

iops

False

size

Capacity

False

existingIops

MaxDisksAllow

Name Type Required Description

numOfDisks

integer

False

reason

string

False

ProviderVolumeTypeResponse

Name Type Required Description

maxDisksAllow

MaxDisksAllow

True

size

Capacity

False

supportedVolumeTypes

array[string]

False

SupportedCapacityTiersResponse

Name Type Required Description

availableTieringPolicies

array[string]

False

supportedCapacityTiers

array[string]

False

volumeType

string

False

SupportedCapacityTiers

Name Type Required Description

capacityTiersDisableReasons

array[string]

False

compositeSupported

boolean

False

forceCompositeVersion

boolean

False

supportedCapacityTiersPerVolumeType

array[SupportedCapacityTiersResponse]

True

CapacityFeatures

Name Type Required Description

defaultProviderVolumeType

DefaultProviderVolume

False

existingIops

array[existingIops]

False

maxDisksPerAggregate

integer

False

providerVolumesType

array[ProviderVolumeTypeResponse]

False

supportedCapacityTiers

SupportedCapacityTiers

False

CbsSchedule

Name Type Required Description

snapmirrorLabel

string

False

snapshotsToKeep

integer

False

ProviderSpecific

Name Type Required Description

azureRgName

string

False

gcpProjectId

string

False

gcpRegion

string

False

CbsPropertiesWithReason

Name Type Required Description

cbsBackupStatus

string

False

cbsPolicyName

string

False

cbsRules

array[CbsSchedule]

False

exclusionReason

string

False

ipSpace

string

False

numberOfBackedUpVolumes

integer

False

objectStoreName

string

False

providerAccountName

string

False

providerSpecific

ProviderSpecific

False

region

string

False

usedCapacity

Capacity

False

DataBrokerPlacement

Name Type Required Description

instanceId

string

False

instanceType

string

False

keyPair

string

False

subnetId

string

False

vpcId

string

False

DataBrokerProperties

Name Type Required Description

dataBrokerPlacement

DataBrokerPlacement

False

id

string

False

name

string

False

CloudSyncRelationship

Name Type Required Description

failureMessage

string

False

id

string

False

progress

integer

False

relationshipStatus

string

False

s3Location

string

False

svmName

string

False

volumeName

string

False

CloudSyncStatus

Name Type Required Description

failureMessage

string

False

status

string

False

CloudSyncProperties

Name Type Required Description

dataBrokerProperties

DataBrokerProperties

False

isSynced

boolean

False

relationships

array[CloudSyncRelationship]

False

s3Location

string

False

status

CloudSyncStatus

False

lastModifiedOffbox

VsaLicense

Name Type Required Description

capacityLimit

Capacity

True

name

string

True

License name

LifResponse

Name Type Required Description

dataProtocols

array[string]

True

List of supported protocols

ip

string

True

LIF IP address

lifType

string

True

LIF type

netmask

string

True

LIF netmask

nodeName

string

True

Node name

privateIp

boolean

True

Specifies whether the IP address is a private address

OntapUpdateImageMetadata

Name Type Required Description

autoUpdateAllowed

boolean

True

imageVersion

string

True

lastModified

integer

True

VsaClusterProperties

Name Type Required Description

accountId

string

False

amiId

string

False

clusterName

string

False

creationTime

integer

False

instanceId

string

False

instanceType

string

False

lastModifiedOffbox

lastModifiedOffbox

False

licenseExpiryDate

integer

False

licenseType

VsaLicense

False

lifs

array[LifResponse]

False

offboxTarget

boolean

False

ontapVersion

string

False

platformLicense

string

False

productCode

string

False

publicDnsName

string

False

publicIp

string

False

serialNumber

string

False

systemId

string

False

systemManagerUrl

string

False

upgradeVersions

array[OntapUpdateImageMetadata]

False

writingSpeedState

string

False

scopeId

ComplianceScanStatusVolumeResponse

Name Type Required Description

error

string

False

name

string

False

scopeId

scopeId

False

status

string

False

ComplianceScanStatusResponse

Name Type Required Description

notScanned

integer

False

scanned

integer

False

volumes

array[ComplianceScanStatusVolumeResponse]

False

ComplianceExtendedStatusResponse

Name Type Required Description

nonSensitiveHits

integer

False

personalHits

integer

False

scanStatus

ComplianceScanStatusResponse

False

sensitivePersonalHits

integer

False

CloudComplianceStatusResponse

Name Type Required Description

complianceBackupStatus

string

False

complianceStatus

ComplianceExtendedStatusResponse

False

lastDeploymentError

string

False

scanStatus

string

False

CronJobSchedule

Name Type Required Description

days

array[string]

False

description

string

False

hours

array[string]

False

minutes

array[string]

False

months

array[string]

True

name

string

False

weekDays

array[string]

False

validTo

AwsEncryptionKey

Name Type Required Description

alias

string

False

default

boolean

False

keyId

string

False

origin

string

False

status

string

False

validTo

validTo

False

CertificateResponse

Name Type Required Description

certificate

string

False

certificateType

string

False

directIssuerName

string

False

endDate

integer

False

publicId

string

False

serialNumber

string

False

startDate

integer

True

subjectName

string

False

KeyManagerResponse

Name Type Required Description

address

string

False

name

string

False

publicId

string

False

status

string

False

usernameField

string

False

usernameValue

string

False

EncryptionProperties

Name Type Required Description

awsEncryptionKey

AwsEncryptionKey

False

awsVolumeEncryption

boolean

False

azureVolumeEncryption

boolean

False

encryptionCertificates

array[CertificateResponse]

False

gcpVolumeEncryption

boolean

False

keyManagers

array[KeyManagerResponse]

False

ontapEncryption

boolean

False

FpolicyProtocolStatus

Name Type Required Description

cifs

integer

False

nfsv3

integer

False

nfsv4

integer

False

FpolicyProperties

Name Type Required Description

fPolicyProtocolStatus

FpolicyProtocolStatus

False

fileExtensions

array[string]

False

status

integer

False

MediatorStatus

Name Type Required Description

statusCode

integer

False

statusMessage

string

False

MediatorVersionInfo

Name Type Required Description

bootVolumeId

string

False

description

string

False

state

string

True

version

string

False

MediatorUpdateVersionMetadata

Name Type Required Description

major

boolean

False

manifestFileName

string

False

mediatorVersion

string

False

metadataFileName

string

False

timeStamp

integer

False

AwsHaProperties

Name Type Required Description

failoverMode

string

False

mediatorStatus

MediatorStatus

False

mediatorVersionInfo

MediatorVersionInfo

False

mediatorVersionsToUpdate

array[MediatorUpdateVersionMetadata]

False

routeTables

array[string]

False

InterClusterLif

Name Type Required Description

address

string

False

isPeered

boolean

False

name

string

False

node

string

False

port

string

False

status

string

False

expirations

LicenseInformation

Name Type Required Description

capacityLimit

Capacity

False

expirations

array[expirations]

False

package

string

True

serialNumbers

array[string]

False

type

string

True

useType

string

True

KpiUnitValue

Name Type Required Description

unit

string

False

value

number

False

MonitoringInfo

Name Type Required Description

averageIops

number

False

averageLatency

KpiUnitValue

False

node1AverageThroughput

KpiUnitValue

False

node2AverageThroughput

KpiUnitValue

False

storageAverageThroughput

KpiUnitValue

False

MonitoringStatusResponse

Name Type Required Description

monitoringInfo

MonitoringInfo

False

monitoringStatus

string

False

tenantUrl

string

False

BroadcastDomainInfo

Name Type Required Description

broadcastDomain

string

False

ipSpace

string

False

mtu

integer

True

CapacityTierInfo

Name Type Required Description

capacityTierUsedSize

Capacity

False

s3BucketName

string

False

tierLevel

string

False

OntapNodeProperties

Name Type Required Description

cloudProviderId

string

False

healthy

boolean

False

inTakeover

boolean

False

lifs

array[LifResponse]

False

name

string

False

platformLicense

string

False

platformSerialNumber

string

False

serialNumber

string

False

systemId

string

False

OntapClusterProperties

Name Type Required Description

aggregateCount

integer

False

broadcastDomainInfos

array[BroadcastDomainInfo]

False

canConfigureCapacityTier

boolean

False

capacityTierInfo

CapacityTierInfo

False

clusterName

string

False

clusterUuid

string

False

creationTime

integer

False

evaluation

boolean

False

flashCache

boolean

False

isKeystoneSubscription

boolean

False

isSpaceReportingLogical

boolean

False

lastModifiedOffbox

lastModifiedOffbox

False

licensePackageName

string

False

licenseType

VsaLicense

False

nodes

array[OntapNodeProperties]

False

offboxTarget

boolean

False

ontapVersion

string

False

systemManagerUrl

string

False

upgradeVersions

array[OntapUpdateImageMetadata]

False

usedCapacity

Capacity

False

userName

string

False

volumeCount

integer

False

vscanFileOperationDefaultProfile

string

False

wormEnabled

boolean

False

writingSpeedState

string

False

ReplicationProperties

Name Type Required Description

peers

array[string]

False

replicationTargets

array[string]

False

freeTrialExpiry

saasEnabled

SaasSubscription

Name Type Required Description

active

boolean

False

id

string

False

name

string

False

CvoSaasProperties

Name Type Required Description

capacityLicensePackage

string

False

freeTrialExpiry

freeTrialExpiry

False

saasEnabled

saasEnabled

False

subscription

SaasSubscription

False

TimePoint

Name Type Required Description

day

integer

True

hour

integer

False

minute

integer

False

StartStopRange

Name Type Required Description

start

TimePoint

False

stop

TimePoint

True

VsaSchedule

Name Type Required Description

enabled

boolean

False

name

string

True

schedule

array[StartStopRange]

True

PolicySchedule

Name Type Required Description

frequency

string

True

Frequency

retention

integer

True

Retention

SnapshotPolicy

Name Type Required Description

description

string

True

Description

name

string

True

Name

schedules

array[PolicySchedule]

True

Schedules

FailureCauses

Name Type Required Description

invalidCloudProviderCredentials

boolean

False

invalidOntapCredentials

boolean

True

noCloudProviderConnection

boolean

False

StatusProperties

Name Type Required Description

extendedFailureReason

string

False

failureCauses

FailureCauses

False

message

string

False

status

string

False

licenseExpiryDate

SupportRegistrationInformation

Name Type Required Description

cloudLicenseExists

boolean

False

licenseExpiryDate

licenseExpiryDate

False

nssAccountId

string

False

serialNumber

string

False

supportRegistrationStatus

string

False

SupportRegistrationProperties

Name Type Required Description

licenseExpiryDate

integer

False

supportRegistrationStatus

string

False

SupportedFeatures

Name Type Required Description

supportsElasticVolumes

boolean

False

supportsGp3Disk

boolean

False

supportsMixedAggregates

boolean

False

supportsTieringWithServiceAccount

boolean

False

Value

Svm

Name Type Required Description

allowedAggregates

array[string]

False

allowedProtocols

array[Value]

True

language

string

False

name

string

False

state

string

False

ver3Enabled

boolean

True

NFS Version 3 enabled

ver4Enabled

boolean

True

NFS Version 4 enabled