JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance RESTful Application Programming Interface
Oracle Technology Network
Library
PDF
Print View
Feedback
search filter icon
search icon

Document Information

Using This Documentation

Chapter 1 Overview

Authentication

Basic Authentication

User Authentication

Session Authentication

API Versions

Service Versions

Common RESTful Operations

HTTP Response Body

HTTP Response Headers

Query Parameters

props

limit

start

Errors

Chapter 2 Working with the API

Chapter 3 Alert Service Commands

Chapter 4 Analytics Services

Chapter 5 Hardware Services

Chapter 6 Log Commands

Chapter 7 Network Commands

Chapter 8 Problem Service Commands

Chapter 9 Role Service

Chapter 10 SAN Services

Chapter 11 Service Commands

Chapter 12 Storage Services

Chapter 13 System Commands

Chapter 14 User Service

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

Errors

Errors return an HTTP status code indicating the error along with the following fault response payload.

JSON Fault Response:

    {
    fault: {
        message: 'ERR_INVALID_ARG',
        details: 'Error Details...',
        code: 500
    }
}

Common Error Codes

Table 1-4  Common Error Codes
Name
Code
Description
ERR_INVALID_ARG
400
Invalid input argument
ERR_UNKNOWN_ARG
400
Extra unhandled input argument
ERR_MISSING_ARG
400
Required input argument missing
ERR_UNAUTHORIZED
401
This user is not authorized to execute command
ERR_DENIED
403
Operation denied
ERR_STATE_CHANGED
Conflict in system state
ERR_NOT_FOUND
404
The requested item was not found
ERR_OBJECT_EXISTS
409
Request creates an object that already exists
ERR_OVER_LIMIT
413
Input request too large to handle
ERR_UNSUPPORTED_MEDIA
415
Requested media type is not supported by request
ERR_NOT_IMPLEMENTED
501
Operation not implemented
ERR_BUSY
503
Service not available due to limited resources