Skip to main content

Retrieve a Cloud Volumes ONTAP system

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

publicId

string

True

name

string

False

tenantId

string

False

svmName

string

False

creatorUserEmail

string

False

status

StatusProperties

False

providerProperties

AzureProperties

False

reservedSize

Capacity

False

clusterProperties

VsaClusterProperties

False

ontapClusterProperties

OntapClusterProperties

False

cloudProviderName

string

False

snapshotPolicies

array[SnapshotPolicy]

True

actionsRequired

array[ActionRequired]

True

activeActions

array[string]

False

replicationProperties

ReplicationProperties

False

schedules

array[VsaSchedule]

True

svms

array[Svm]

True

workingEnvironmentType

string

False

supportRegistrationProperties

SupportRegistrationProperties

False

supportRegistrationInformation

array[SupportRegistrationInformation]

True

capacityFeatures

CapacityFeatures

False

encryptionProperties

EncryptionProperties

False

supportedFeatures

SupportedFeatures

False

isHA

boolean

False

haProperties

AzureHaProperties

False

fpolicyProperties

FpolicyProperties

False

saasProperties

CvoSaasProperties

False

cbsProperties

CbsPropertiesWithReason

False

complianceProperties

CloudComplianceStatusResponse

False

monitoringProperties

MonitoringStatusResponse

False

licensesInformation

array[LicenseInformation]

True
Example error response 
{
  "publicId": "string",
  "name": "string",
  "tenantId": "string",
  "svmName": "string",
  "creatorUserEmail": "string",
  "status": {
    "status": "string",
    "message": "string",
    "extendedFailureReason": "string"
  },
  "providerProperties": {
    "regionName": "string",
    "vnetCidr": "string",
    "subscriptionId": "string",
    "deploymentId": "string",
    "instanceType": "string",
    "subscriptionName": "string",
    "cloudProviderAccountId": "string",
    "dataDisks": [
      {
        "name": "string",
        "id": "string",
        "caching": "string",
        "accountType": "string",
        "encryptionSet": "string"
      }
    ]
  },
  "clusterProperties": {
    "lifs": [
      {}
    ],
    "serialNumber": "string",
    "systemId": "string",
    "clusterName": "string",
    "ontapVersion": "string",
    "accountId": "string",
    "productCode": "string",
    "amiId": "string",
    "systemManagerUrl": "string",
    "instanceId": "string",
    "platformLicense": "string",
    "instanceType": "string",
    "publicIp": "string",
    "publicDnsName": "string",
    "upgradeVersions": [
      {}
    ],
    "writingSpeedState": "string"
  },
  "ontapClusterProperties": {
    "nodes": [
      {
        "name": "string",
        "lifs": [
          {}
        ],
        "serialNumber": "string",
        "systemId": "string",
        "platformLicense": "string",
        "platformSerialNumber": "string",
        "cloudProviderId": "string"
      }
    ],
    "clusterName": "string",
    "clusterUuid": "string",
    "ontapVersion": "string",
    "systemManagerUrl": "string",
    "licensePackageName": "string",
    "upgradeVersions": [
      {}
    ],
    "writingSpeedState": "string",
    "broadcastDomainInfos": [
      {}
    ],
    "capacityTierInfo": {
      "s3BucketName": "string",
      "tierLevel": "string"
    },
    "userName": "string",
    "vscanFileOperationDefaultProfile": "string"
  },
  "cloudProviderName": "string",
  "snapshotPolicies": [
    {
      "name": "string",
      "schedules": [
        {}
      ],
      "description": "string"
    }
  ],
  "actionsRequired": [
    {}
  ],
  "activeActions": [
    "string"
  ],
  "replicationProperties": {
    "peers": [
      "string"
    ],
    "replicationTargets": [
      "string"
    ]
  },
  "schedules": [
    {
      "name": "string",
      "schedule": [
        {}
      ]
    }
  ],
  "svms": [
    {}
  ],
  "workingEnvironmentType": "string",
  "supportRegistrationProperties": {
    "supportRegistrationStatus": "string"
  },
  "supportRegistrationInformation": [
    {
      "supportRegistrationStatus": "string",
      "serialNumber": "string",
      "nssAccountId": "string"
    }
  ],
  "capacityFeatures": {
    "providerVolumesType": [
      {
        "supportedVolumeTypes": [
          "string"
        ],
        "maxDisksAllow": {
          "reason": "string"
        }
      }
    ],
    "defaultProviderVolumeType": {
      "diskType": "string",
      "capacityTier": "string"
    },
    "supportedCapacityTiers": {
      "supportedCapacityTiersPerVolumeType": [
        {
          "volumeType": "string",
          "supportedCapacityTiers": [
            "string"
          ],
          "availableTieringPolicies": [
            "string"
          ]
        }
      ],
      "capacityTiersDisableReasons": [
        "string"
      ]
    },
    "existingIops": [
      "object"
    ]
  },
  "encryptionProperties": {
    "keyManagers": [
      {
        "publicId": "string",
        "name": "string",
        "address": "string",
        "usernameField": "string",
        "usernameValue": "string",
        "status": "string"
      }
    ],
    "encryptionCertificates": [
      {}
    ],
    "awsEncryptionKey": {
      "alias": "string",
      "keyId": "string",
      "status": "string",
      "origin": "string"
    }
  },
  "haProperties": {
    "loadBalancerName": "string",
    "applicationSecurityGroupName": "string",
    "azureHaDeploymentType": "string"
  },
  "fpolicyProperties": {
    "fileExtensions": [
      "string"
    ]
  },
  "saasProperties": {
    "subscription": {
      "id": "string",
      "name": "string"
    },
    "capacityLicensePackage": "string"
  },
  "cbsProperties": {
    "cbsBackupStatus": "string",
    "cbsRules": [
      {
        "snapmirrorLabel": "string"
      }
    ],
    "objectStoreName": "string",
    "providerSpecific": {
      "azureRgName": "string",
      "gcpProjectId": "string",
      "gcpRegion": "string"
    },
    "cbsPolicyName": "string",
    "ipSpace": "string",
    "region": "string",
    "providerAccountName": "string",
    "exclusionReason": "string"
  },
  "complianceProperties": {
    "scanStatus": "string",
    "complianceStatus": {
      "scanStatus": {
        "volumes": [
          {
            "name": "string",
            "status": "string",
            "error": "string"
          }
        ]
      }
    },
    "lastDeploymentError": "string",
    "complianceBackupStatus": "string"
  },
  "monitoringProperties": {
    "monitoringStatus": "string",
    "monitoringInfo": {
      "averageLatency": {
        "unit": "string"
      },
      "storageAverageThroughput": {
        "unit": "string"
      },
      "node1AverageThroughput": {
        "unit": "string"
      },
      "node2AverageThroughput": {
        "unit": "string"
      }
    },
    "tenantUrl": "string"
  },
  "licensesInformation": [
    {
      "type": "string",
      "useType": "string",
      "package": "string",
      "serialNumbers": [
        "string"
      ],
      "expirations": [
        "object"
      ]
    }
  ]
}

Definitions

See Definitions

Expand

Name Type Required Description

name

string

False

Expands

Name Type Required Description

raw

string

True

expands

array[Expand]

True

FailureCauses

Name Type Required Description

invalidOntapCredentials

boolean

True

noCloudProviderConnection

boolean

False

invalidCloudProviderCredentials

boolean

False

StatusProperties

Name Type Required Description

status

string

False

message

string

False

failureCauses

FailureCauses

False

extendedFailureReason

string

False

tags Hash mapping strings to string

Name Type Required Description

traversableAgain

boolean

False

empty

boolean

False

AzureResourceGroupResponse

Name Type Required Description

name

string

False

location

string

False

tags

tags

True

availabilityZone

AzureDataDiskResponse

Name Type Required Description

name

string

False

diskSizeGB

integer

False

lun

integer

False

id

string

False

caching

string

False

accountType

string

False

managed

boolean

False

encryptionSet

string

False

AzureProperties

Name Type Required Description

regionName

string

False

resourceGroup

AzureResourceGroupResponse

False

vnetCidr

string

False

tags

tags

False

subscriptionId

string

False

deploymentId

string

False

creationTime

integer

False

instanceType

string

False

numOfNics

integer

False

singleNetworkInterface

boolean

False

subscriptionName

string

False

cloudProviderAccountId

string

False

availabilityZone

availabilityZone

False

dataDisks

array[AzureDataDiskResponse]

False

Capacity

Name Type Required Description

size

number

True

unit

string

True

LifResponse

Name Type Required Description

ip

string

True

netmask

string

True

lifType

string

True

dataProtocols

array[string]

True

nodeName

string

True

privateIp

boolean

True

VsaLicense

Name Type Required Description

name

string

True

capacityLimit

Capacity

True

lastModifiedOffbox

OntapUpdateImageMetadata

Name Type Required Description

imageVersion

string

True

lastModified

integer

True

autoUpdateAllowed

boolean

True

VsaClusterProperties

Name Type Required Description

lifs

array[LifResponse]

False

serialNumber

string

False

systemId

string

False

clusterName

string

False

ontapVersion

string

False

accountId

string

False

productCode

string

False

amiId

string

False

systemManagerUrl

string

False

creationTime

integer

False

instanceId

string

False

platformLicense

string

False

licenseExpiryDate

integer

False

instanceType

string

False

publicIp

string

False

publicDnsName

string

False

licenseType

VsaLicense

False

lastModifiedOffbox

lastModifiedOffbox

False

offboxTarget

boolean

False

upgradeVersions

array[OntapUpdateImageMetadata]

False

writingSpeedState

string

False

OntapNodeProperties

Name Type Required Description

name

string

False

lifs

array[LifResponse]

False

serialNumber

string

False

systemId

string

False

platformLicense

string

False

platformSerialNumber

string

False

cloudProviderId

string

False

healthy

boolean

False

inTakeover

boolean

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

OntapClusterProperties

Name Type Required Description

nodes

array[OntapNodeProperties]

False

clusterName

string

False

clusterUuid

string

False

ontapVersion

string

False

systemManagerUrl

string

False

creationTime

integer

False

licenseType

VsaLicense

False

licensePackageName

string

False

isKeystoneSubscription

boolean

False

lastModifiedOffbox

lastModifiedOffbox

False

offboxTarget

boolean

False

upgradeVersions

array[OntapUpdateImageMetadata]

False

writingSpeedState

string

False

broadcastDomainInfos

array[BroadcastDomainInfo]

False

evaluation

boolean

False

capacityTierInfo

CapacityTierInfo

False

canConfigureCapacityTier

boolean

False

usedCapacity

Capacity

False

userName

string

False

wormEnabled

boolean

False

isSpaceReportingLogical

boolean

False

vscanFileOperationDefaultProfile

string

False

aggregateCount

integer

False

volumeCount

integer

False

flashCache

boolean

False

PolicySchedule

Name Type Required Description

frequency

string

True

retention

integer

True

SnapshotPolicy

Name Type Required Description

name

string

True

schedules

array[PolicySchedule]

True

description

string

True

RaidInfoForEvAggregate

Name Type Required Description

numOfDisks

integer

True

diskSize

Capacity

True

ElasticVolumeQuoteInfo

Name Type Required Description

totalCapacityToAdd

Capacity

False

addedCapacityToExistingEvDisks

Capacity

False

newRaidForEvInfo

array[RaidInfoForEvAggregate]

False

totalEvDisks

integer

False

VolumeMoveParameters

Name Type Required Description

volumeName

string

False

svmName

string

False

targetAggregateName

string

False

isNewTargetAggregate

boolean

False

homeNode

string

False

OntapLicenseType

Name Type Required Description

type

string

False

name

string

False

description

string

False

subName

string

False

subDescription

string

False

capacity_limit

string

False

platformLicenseRequired

boolean

False

default

boolean

False

capacityLimit

Capacity

True

ChangeLicenseParameters

Name Type Required Description

newLicenseType

OntapLicenseType

False

newInstanceType

string

False

InstanceNameIdAndType

Name Type Required Description

instanceName

string

False

instanceType

string

False

instanceId

string

False

DisksDetails

Name Type Required Description

numberOfDisks

integer

False

diskSize

Capacity

False

diskType

string

False

ResourcesToDelete

Name Type Required Description

instanceNameAndType

array[InstanceNameIdAndType]

False

numberOfDisksAndDiskSize

array[DisksDetails]

False

VolumeInfo

Name Type Required Description

volumeName

string

False

svmName

string

False

newCapacity

Capacity

False

ActionRequiredParameters

Name Type Required Description

aggregateName

string

True

numOfDisks

integer

True

totalCapacity

Capacity

True

evCapacityDetails

ElasticVolumeQuoteInfo

False

volumeNames

array[string]

True

maxCapacity

Capacity

True

licenseExpiryDate

integer

True

serialNumber

string

True

volumeMoveParameters

VolumeMoveParameters

False

workingEnvironmentId

string

True

licenseParameters

ChangeLicenseParameters

False

resourcesToDelete

ResourcesToDelete

False

instances

array[InstanceNameIdAndType]

True

moreInfo

string

False

providerVolumeType

string

False

volumeInfo

VolumeInfo

False

currentInstanceType

string

False

isComposite

boolean

True

isCapacityBased

boolean

True

ActionRequired

Name Type Required Description

actionType

string

True

parameters

ActionRequiredParameters

True

severity

string

True

ReplicationProperties

Name Type Required Description

peers

array[string]

False

replicationTargets

array[string]

False

TimePoint

Name Type Required Description

day

integer

True

hour

integer

False

minute

integer

False

StartStopRange

Name Type Required Description

stop

TimePoint

True

start

TimePoint

False

VsaSchedule

Name Type Required Description

name

string

True

schedule

array[StartStopRange]

True

enabled

boolean

False

Value

Svm

Name Type Required Description

name

string

False

state

string

False

allowedProtocols

array[Value]

True

language

string

False

allowedAggregates

array[string]

False

ver3Enabled

boolean

True

ver4Enabled

boolean

True

SupportRegistrationProperties

Name Type Required Description

supportRegistrationStatus

string

False

licenseExpiryDate

integer

False

licenseExpiryDate

SupportRegistrationInformation

Name Type Required Description

supportRegistrationStatus

string

False

serialNumber

string

False

licenseExpiryDate

licenseExpiryDate

False

cloudLicenseExists

boolean

False

nssAccountId

string

False

MaxDisksAllow

Name Type Required Description

numOfDisks

integer

False

reason

string

False

ProviderVolumeTypeResponse

Name Type Required Description

size

Capacity

False

supportedVolumeTypes

array[string]

False

maxDisksAllow

MaxDisksAllow

True

iops

DefaultProviderVolume

Name Type Required Description

size

Capacity

False

diskType

string

False

capacityTier

string

False

iops

iops

False

SupportedCapacityTiersResponse

Name Type Required Description

volumeType

string

False

supportedCapacityTiers

array[string]

False

availableTieringPolicies

array[string]

False

SupportedCapacityTiers

Name Type Required Description

supportedCapacityTiersPerVolumeType

array[SupportedCapacityTiersResponse]

True

capacityTiersDisableReasons

array[string]

False

compositeSupported

boolean

False

forceCompositeVersion

boolean

False

existingIops

CapacityFeatures

Name Type Required Description

providerVolumesType

array[ProviderVolumeTypeResponse]

False

defaultProviderVolumeType

DefaultProviderVolume

False

supportedCapacityTiers

SupportedCapacityTiers

False

maxDisksPerAggregate

integer

False

existingIops

array[existingIops]

False

KeyManagerResponse

Name Type Required Description

publicId

string

False

name

string

False

address

string

False

usernameField

string

False

usernameValue

string

False

status

string

False

CertificateResponse

Name Type Required Description

publicId

string

False

directIssuerName

string

False

subjectName

string

False

startDate

integer

True

endDate

integer

False

serialNumber

string

False

certificate

string

False

certificateType

string

False

validTo

AwsEncryptionKey

Name Type Required Description

alias

string

False

keyId

string

False

status

string

False

validTo

validTo

False

origin

string

False

default

boolean

False

EncryptionProperties

Name Type Required Description

ontapEncryption

boolean

False

awsVolumeEncryption

boolean

False

azureVolumeEncryption

boolean

False

gcpVolumeEncryption

boolean

False

keyManagers

array[KeyManagerResponse]

False

encryptionCertificates

array[CertificateResponse]

False

awsEncryptionKey

AwsEncryptionKey

False

SupportedFeatures

Name Type Required Description

supportsMixedAggregates

boolean

False

supportsTieringWithServiceAccount

boolean

False

supportsGp3Disk

boolean

False

supportsElasticVolumes

boolean

False

AzureAvailabilitySet

Name Type Required Description

faultDomain

integer

False

updateDomain

integer

False

AzureHaNodeInfo

Name Type Required Description

instanceName

string

False

instanceId

string

False

primaryIp

string

False

state

string

False

serialNumber

string

False

availabilitySet

AzureAvailabilitySet

True

availabilityZone

availabilityZone

False

AzureHaProperties

Name Type Required Description

loadBalancerName

string

False

haEnabledOnLbRules

boolean

False

node1Info

AzureHaNodeInfo

False

node2Info

AzureHaNodeInfo

False

multiZone

boolean

False

applicationSecurityGroupName

string

False

azureHaDeploymentType

string

False

FpolicyProtocolStatus

Name Type Required Description

nfsv3

integer

False

nfsv4

integer

False

cifs

integer

False

FpolicyProperties

Name Type Required Description

status

integer

False

fPolicyProtocolStatus

FpolicyProtocolStatus

False

fileExtensions

array[string]

False

SaasSubscription

Name Type Required Description

id

string

False

name

string

False

active

boolean

False

freeTrialExpiry

saasEnabled

CvoSaasProperties

Name Type Required Description

subscription

SaasSubscription

False

freeTrialExpiry

freeTrialExpiry

False

saasEnabled

saasEnabled

False

capacityLicensePackage

string

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

cbsRules

array[CbsSchedule]

False

numberOfBackedUpVolumes

integer

False

objectStoreName

string

False

providerSpecific

ProviderSpecific

False

cbsPolicyName

string

False

usedCapacity

Capacity

False

ipSpace

string

False

region

string

False

providerAccountName

string

False

exclusionReason

string

False

scopeId

ComplianceScanStatusVolumeResponse

Name Type Required Description

name

string

False

status

string

False

error

string

False

scopeId

scopeId

False

ComplianceScanStatusResponse

Name Type Required Description

scanned

integer

False

notScanned

integer

False

volumes

array[ComplianceScanStatusVolumeResponse]

False

ComplianceExtendedStatusResponse

Name Type Required Description

sensitivePersonalHits

integer

False

personalHits

integer

False

nonSensitiveHits

integer

False

scanStatus

ComplianceScanStatusResponse

False

CloudComplianceStatusResponse

Name Type Required Description

scanStatus

string

False

complianceStatus

ComplianceExtendedStatusResponse

False

lastDeploymentError

string

False

complianceBackupStatus

string

False

KpiUnitValue

Name Type Required Description

value

number

False

unit

string

False

MonitoringInfo

Name Type Required Description

averageIops

number

False

averageLatency

KpiUnitValue

False

storageAverageThroughput

KpiUnitValue

False

node1AverageThroughput

KpiUnitValue

False

node2AverageThroughput

KpiUnitValue

False

MonitoringStatusResponse

Name Type Required Description

monitoringStatus

string

False

monitoringInfo

MonitoringInfo

False

tenantUrl

string

False

expirations

LicenseInformation

Name Type Required Description

type

string

True

useType

string

True

package

string

True

serialNumbers

array[string]

False

capacityLimit

Capacity

False

expirations

array[expirations]

False