volume list

Lists information about volumes specified by name, path, or filter.

See the Fields table on the volume page for the fields available to filter. See the Filters for more information.

Syntax

CLI
maprcli volume list
    [ -alarmedvolumes 0|1 ]
    [ -cluster <cluster> ]
    [ -columns <columns> ]
    [ -filter <filter> ]
    [ -limit <limit> ]
    [ -nodes <nodes> ]
    [ -output terse | verbose ]
    [ -start <offset> ]
Note: For best results, use the -json option when running volume list from the command line.
REST
http[s]://<host>:<port>/rest/volume/list?<parameters> 

Parameters

Parameter

Description

alarmedvolumes

Specifies whether (1) or not (0) to list alarmed volumes only. Default: 0

cluster

The cluster name on which to run the command.

columns

A comma-separated list of fields to return in the query. See the Fields table on the volume page. Note: When issuing maprcli volume info -columns and marcli volume list -columns commands, the column for the volume name is volumename.

filter

A filter specifying volumes to list. See Filters for more information. Default: none

limit

The number of rows to return, beginning at start. Default: 2147483647

nodes

A list of nodes. If specified, volume list only lists volumes on the specified nodes.

output

Specifies whether the output should be terse or verbose. Default: verbose

start

The offset from the starting row according to sort. Default: 0

Fields

For definitions of the output fields, and short names for use with filters, see the Fields table on the volume command page.

Output

Information about the specified volumes.

{
    "timestamp":1435363624712,
    "timeofday":"2015-06-26 05:07:04.712 GMT-0700",
    "status":"OK",
    "total":14,
    "data":[
        {
            "creator":"mapr",
            "aename":"mapr",
            "aetype":0,
            "numreplicas":"3",
            "minreplicas":"1",
            "nsNumReplicas":"3",
            "nsMinReplicas":"1",
            "allowGrant":"false",
            "reReplTimeOutSec":"0",
            "replicationtype":"high_throughput",
            "rackpath":"/data",
            "accesstime":"June 25, 2015",
            "readonly":"0",
            "mountdir":"",
            "volumename":"mapr.cldb.internal",
            "mounted":0,
            "quota":"0",
            "advisoryquota":"0",
            "snapshotcount":"0",
            "logicalUsed":"1",
            "used":"1",
            "snapshotused":"0",
            "totalused":"1",
            "scheduleid":0,
            "schedulename":"",
            "mirrorscheduleid":0,
            "volumetype":0,
            "mirrortype":0,
            "creatorcontainerid":0,
            "creatorvolumeuuid":"",
            "volumeid":1,
            "actualreplication":[
                0,
                100,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0,
                0
            ],
            "nameContainerSizeMB":0,
            "needsGfsck":false,
            "maxinodesalarmthreshold":"0",
            "dbrepllagsecalarmthresh":"0",
            "limitspread":"true",
            "partlyOutOfTopology":0,
            "auditVolume":0,
            "audited":0,
            "coalesceInterval":60,
            "mirrorSrcVolume":"",
            "mirrorSrcVolumeId":0,
            "mirrorSrcCluster":"",
            "mirrorDataSrcVolume":"",
            "mirrorDataSrcVolumeId":0,
            "mirrorDataSrcCluster":"",
            "lastSuccessfulMirrorTime":0,
            "mirror-percent-complete":0,
            "mirrorId":0,
            "nextMirrorId":0,
            "mirrorstatus":1,
            "numcontainers":"0",
            "SnapshotFailureAlarm":0,
            "MirrorFailureAlarm":0,
            "DataUnderReplicatedAlarm":1435351165700,
            "DataUnavailableAlarm":0,
            "AdvisoryQuotaExceededAlarm":0,
            "QuotaExceededAlarm":0,
            "NoNodesInTopologyAlarm":0,
            "AlmostFullTopologyAlarm":0,
            "FullTopologyAlarm":0,
            "InodesExceededAlarm":0,
            "ContainersNonLocalAlarm":0,
            "TableReplicationLagHighAlarm":0,
            "LargeRowWarning":0,
            "TableReplicationErrorAlarm":0,
            "TableReplicationAsyncAlarm":0
        }
    ]
}

Examples

List all volumes

CLI
maprcli volume list -json
REST
https://10.10.82.23:8443/rest/volume/list

List the first ten volumes

The start and limit parameters are useful for windowing the results. You can list the first ten volumes, then the next ten, and so on.

CLI
maprcli volume list -start 0 -limit 10
REST
https://r1n1.sj.us:8443/rest/node/list?start=0&limit=10

Filter by aename

CLI
maprcli volume list -filter '[aename==mapr]' -columns volumeid
REST
https://10.10.82.23:8443/rest/volume/list?filter=%5Baename%3D%3Dmapr%5D&columns=volumeid