Terms and concepts

Contributors netapp-jolieg

The following terms apply to the Web Services Proxy.

Term Definition

API

An Application Programming Interface (API) is a set of protocols and methods that enables developers to communicate with devices. The Web Services API is used to communicate with E-Series storage systems.

ASUP

The AutoSupport (ASUP) feature collects data in a customer support bundle and automatically sends the message file to technical support for remote troubleshooting and problem analysis.

Endpoint

Endpoints are functions that are available through the API. An endpoint includes an HTTP verb, plus the URI path. In Web Services, endpoints can execute such tasks as discovering storage systems and creating volumes.

HTTP Verb

An HTTP verb is a corresponding action for an endpoint, such as retrieving and creating data. In Web Services, HTTP verbs include POST, GET, and DELETE.

JSON

JavaScript Object Notation (JSON) is a structured data format much like XML, which uses a minimal, readable format. Data within Web Services is encoded through JSON.

REST / RESTful

Representational state transfer (REST) is a loose specification that defines an architectural style for an API. Because most REST APIs do not fully adhere to the specification, they are described as “RESTful” or “REST-like.” Generally, a “RESTful” API is agnostic to programming languages and has the following characteristics:

  • HTTP-based, which follows the general semantics of the protocol

  • Producer and consumer of structured data (JSON, XML, etc.)

  • Object-oriented (as opposed to operation-oriented)

Web Services is a RESTful API that provides access to virtually all the SANtricity management capabilities.

storage system

A storage system is an E-Series array, which includes shelves, controllers, drives, software, and firmware.

SYMbol API

SYMbol is a legacy API for managing E-Series storage systems. The underlying implementation of the Web Services API uses SYMbol.

Web Services

Web Services is an API that NetApp designed for developers to manage E-Series storage systems. There are two implementations of Web Services: embedded on the controller and a separate proxy that can be installed on Linux or Windows.