Skip to main content

Retrieve data service eligibility details

GET /license/data-service-eligibility/account/{accountId}/provider/{cloudProvider}

Retrieves data service eligibility details to determine whether an account is eligible to use a data service in an on-premises or cloud environment.

Note:

  • You can use a user token or service token with scope: license:internal.

  • accountId, cloudProvider, and service are required parameters.

  • The 'SGWS' value in the cloudProvider parameter denotes that the feature details request is for an on-premises ONTAP system backed up in StorageGRID and retrieves only license details.

  • cloudAccountId and cvoId are optional parameters.

  • If the feature details request is for a Cloud Volumes ONTAP or an on-premises ONTAP system backed up on a cloud, you must provide cloudAccountId.

  • If the feature details request is for Cloud Volumes ONTAP, you must provide the cvoId parameter that is used to retrieve the Cloud Volumes ONTAP package.

  • The TotalServiceLicensesCapacity value is in TB, the TotalServiceLicensesUsedCapacity value is in TiB, and the FreeTrialEndDate value is in ISO 8601 format.

Token usage: Either a NetApp Console user token or service token.

Parameters

Name Type In Required Description

service

string

query

True

cloudAccountId

["string", "null"]

query

False

cvoId

["string", "null"]

query

False

accountId

string

path

True

cloudProvider

string

path

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response
Name Type Required Description

totalServiceLicensesCapacity

integer

False

totalServiceLicensesUsedCapacity

number

False

subscriptionDetails

subscriptionDetails

False

freeTrialEndDate

string

False
Example response 
{
  "subscriptionDetails": {
    "subscriptionId": "string"
  },
  "freeTrialEndDate": "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

subscriptionDetails

Name Type Required Description

subscriptionId

string

False

active

boolean

False