Skip to main content

Retrieve a Cloud Volumes ONTAP system

GET /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

cloudProviderName

string

False

isHA

boolean

False

licensesInformation

array[LicenseInformation]

True

name

string

False

ontapClusterProperties

OntapClusterProperties

False

publicId

string

True

status

StatusProperties

False

userTags

userTags

True

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

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

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

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

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

OntapUpdateImageMetadata

Name Type Required Description

autoUpdateAllowed

boolean

True

imageVersion

string

True

lastModified

integer

True

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

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

userTags Hash mapping strings to string

Name Type Required Description

empty

boolean

False

traversableAgain

boolean

False