Skip to main content
NetApp Knowledgebase

API Services to Unified Manager 9.7 REST API mapping

Views:
387
Visibility:
Public
Votes:
0
Category:
oncommand-unified-manager
Specialty:
om
Last Updated:

Applies to

Unified Manager 9.7

Answer

What features did OnCommand API Services provide and how long will it be supported? 

The OnCommand API Services product supplies REST APIs. Partner applications use these APIs to programmatically execute specified data storage monitoring, information retrieval operations, and active management on storage systems run by NetApp ONTAP® software.  

OnCommand API Services 2.2 will be supported till April 2021.  

Do we have a product from where we can obtain API Services REST API functionality? 

REST API functionality provided by OnCommand API Services can be obtained from Unified Manager 9.7 datacenter scoped REST APIs and can use gateway to call ONTAP REST APIs. 

What are the advantages of using Unified Manager gateway APIs? 

The gateway APIs provides advantage of using the Active IQ Unified Manager credentials to run ONTAP system scoped REST APIs and managing storage objects. 

Also, without the requirement of installing an additional system for running the APIs, it enables the user to manage ONTAP programmatically at data center and at cluster level. It is recommended that users use REST APIs available with Unified Manager 9.7 and ONTAP 9.7; ONTAP will continue to deliver additional REST API endpoints for new features.  

I use API Services for automation today; I would like to understand which product provides these capabilities? 

To enable existing users of API Services, mapping of API Services REST API to Active IQ Unified Manager 9.7 REST API endpoints are available in the OnCommand_APIs_to_UM_APIs_Mapping.xlsx excel sheet. 

Notes:

  •  AIQ UM APIs will not return records or information in the same data format as API Services.  

  • Also, the gateway APIs in AIQ UM will present a data model different to the data center scoped APIs. 

e.g.: JSON structure, parameter names  

How to read this mapping document? 

Terminology used in this document: 

  • API Services API path: API Services REST API endpoint  

  • AIQ UM 9.7 API path: Unified Manager 9.7 REST API endpoint  

  • Type: 

  • AIQ UM API: Direct API endpoint from UM 

  • API Gateway: Pass through to ONTAP REST APIs endpoint from UM  

  • Not supported: No equivalent APIs endpoint available 

  • Scope:  

  • Datacenter level: Process API query and performs at data center level 

  • Cluster level: Process API query and performs at cluster level 

Example 1: 

If a user is consuming API-S API endpoint GET /6.0/ontap/aggregates to retrieve the aggregate details, the equivalent API is available to use on Unified Manager 9.7 which is datacenter scoped, GET /api/v2/datacenter/storage/aggregates endpoint. 

Example 2:  

If a user is consuming API-S API endpoint POST /6.0/ontap/aggregates to create aggregates, the equivalent is available in Unified Manager 9.7 gateway REST API endpoint which is cluster scoped, POST /api/v2/gateways/{CLUSTER}/storage/aggregates  

Note: The gateway APIs provide you with Active IQ Unified Manager credentials to run ONTAP system scoped REST APIs. 

API Services can cache changes. Does AIQ UM product provide this capability? 

API Services can cache changes and use them for GET operations till the next data acquisition on the cluster. AIQ Unified Manager is not aware of the changes until the next data acquisition on the cluster.  A workaround in this scenario is to use GET on gateway API to be aware of the changes.   

Scenario: Creating a new volume using UM Gateway API 

  1. POST a Volume on ONTAP using Gateway (cache the UUID of newly created volume) 

  1. Use the Gateway API Volume GET to get the volume and perform operations on it. 

  1. For provisioning decisions within the next Unified Manager acquisition cycle, use the Gateway API to get capacity details on aggregates 

For more information, see:  

Additional Information

additionalInformation_text