Overview

This guide provides information about the MapR command API. Most commands can be run on the command-line interface (CLI), or by making REST requests programmatically or in a browser. To run CLI commands, use a Client machine or an ssh connection to any node in the cluster. To use the REST interface, make HTTP requests to a node that is running the WebServer service.

Each command reference page includes the command syntax, a table that describes the parameters, and examples of command usage. In each parameter table, required parameters are in bold text. For output commands, the reference pages include tables that describe the output fields. Values that do not apply to particular combinations are marked NA.

REST API Syntax

MapR REST calls use the following format:

https://<host>:<port>/rest/<command>[/<subcommand>...]?<parameters>

Construct the <parameters> list from the required and optional parameters, in the format <parameter>=<value> separated by the ampersand (&) character. Example:

https://r1n1.qa.sj.ca.us:8443/api/volume/mount?name=test-volume&path=/test

Values in REST API calls must be URL-encoded. For readability, the values in this document are presented using the actual characters, rather than the URL-encoded versions.

Authentication

To make REST calls using curl or wget, provide the username and password.

Curl Syntax

curl -k -u <username>:<password> https://<host>:<port>/rest/<command>...

Wget Syntax

wget --no-check-certificate --user <username> --password <password> https://<host>:<port>/rest/<command>...

Command-Line Interface (CLI) Syntax

The MapR CLI commands are documented using the following conventions:

• [Square brackets] indicate an optional parameter
• <Angle brackets> indicate a value to enter

The following syntax example shows that the volume mount command requires the -name parameter, for which you must enter a list of volumes, and all other parameters are optional:

maprcli volume mount
    [ -cluster <cluster> ]
    -name <volume list>
    [ -path <path list> ]

For clarity, the syntax examples show each parameter on a separate line; in practical usage, the command and all parameters and options are typed on a single line. Example:

maprcli volume mount -name test-volume -path /test

Common Parameters

The following parameters are available for many commands in both the REST and command-line contexts.

Common Options

The following options are available for most commands in the command-line context.

Filters

Some MapR CLI commands use filters, which let you specify large numbers of nodes or volumes by matching specified values in specified fields rather than by typing each name explicitly.

Filters use the following format:

[<field><operator>"<value>"]<and|or>[<field><operator>"<value>"] ...

You can use the wildcard (*) for partial matches. For example, you can display all volumes whose owner is root and whose name begins with test as follows:

maprcli volume list -filter [n=="test*"]and[on=="root"]

Response

The commands return responses in JSON or in a tabular format. When you run commands from the command line, the response is returned in tabular format unless you specify JSON using the -json option; when you run commands through the REST interface, the response is returned in JSON.

Success

On a successful call, each command returns the error code zero (OK) and any data requested. When JSON output is specified, the data is returned as an array of records along with the status code and the total number of records. In the tabular format, the data is returned as a sequence of rows, each of which contains the fields in the record separated by tabs.

{
	"status":"OK",
	"total":<number of records>,
	"data":[
		{
			<record>
		}
		...
         ]
}
 

status
0

<heading>   <heading>   <heading> ...
<field>     <field>     <field> ...
...

Error

When an error occurs, the command returns the error code and descriptive message.

{
    "status":"ERROR",
    "errors":[
        {
            "id":<error code>,
            "desc":"<command>: <error message>"
        }
    ]
} 

 ERROR (<error code>) -  <command>: <error message>