Skip to main content

Retrieve on-prem ONTAP data

Contributors

GET /license/onPrem/account/{accountId}/clusters

Retrieves on-premises (on-prem) ONTAP cluster data.
The ONTAP cluster must be configured for AutoSupport to send back the telemetry and configuration data to NetApp.

Data retrieved by this endpoint is comprised mostly of ONTAP cluster configuration details
(such as cluster management IP address, capacity, contract date, feature licenses, and more).

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

accountId

string

path

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Account onPremise data
Name Type Required Description

partialResponse

boolean

False

clusterData

array[clusterData]

False

Example response
{
  "clusterData": [
    {
      "hostName": "string",
      "serialNumber": "string",
      "hardwareContractEndDate": "string",
      "softwareContractEndDate": "string",
      "serviceTier": "string",
      "clusterIp": "string",
      "clusterName": "string",
      "clusterId": "string"
    }
  ]
}

Response

Status: 4xx, Error response
Name Type Required Description

errorCode

string

False

error code

error

string

False

Error code/category

message

string

False

Error description message

Example response
{
  "errorCode": "string",
  "error": "string",
  "message": "string"
}

Definitions

See Definitions

clusterData

Name Type Required Description

hostName

string

False

serialNumber

string

False

hardwareContractEndDate

string

False

softwareContractEndDate

string

False

serviceTier

string

False

clusterIp

string

False

clusterName

string

False

clusterId

string

False

usedCapacity

integer

False

allocatedCapacity

integer

False

discovered

boolean

False

Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response