stream replica list

Permission required to run this command: Your user ID must have the adminperm permission on the stream.

NOTE: The mapr user is not treated as a superuser. MapR Streams does not allow the mapr user to run this command unless that user is given the relevant permission or permissions with access-control expressions.

Syntax

CLI	`stream replica list -path stream path [ -refreshnow refreshnow. default: false ]`
REST	`http[s]://<host>:<port>/rest/stream/replica/list?path=<path>`

Parameters

Parameter	Description
`path`	The path and name of the stream that you want to list the replicas of.
`refreshnow`	A boolean value that specifies whether to trigger an immediate update of the replica statistics. The values are `true` or `false`. By default, the value is `false` and the command lists the current version of the replica statistics, which could be a maximum of five minutes old.

Sample Output

# maprcli stream replica list -path /src -json
{
	"timestamp":1437992580636,
	"timeofday":"2015-07-27 03:23:00.636 GMT-0700",
	"status":"OK",
	"total":1,
	"data":[
		{
			"cluster":"my.cluster.com",
			"stream":"/dst",
			"paused":false,
			"throttle":false,
			"idx":1,
			"networkencryption":false,
			"synchronous":false,
			"networkcompression":"lz4",
			"isUptodate":true,
			"minPendingTS":0,
			"maxPendingTS":0,
			"bytesPending":0,
			"bucketsPending":0,
			"uuid":"61d9b2d4-4ca7-1ea0-7327-0d2902b65500"
		}
	]
}

Field Descriptions

cluster: The cluster on which the replica stream resides.
stream: The name of the replica stream.
paused: A Boolean values that specifies if replication is paused.
throttle: A Boolean value that specifies if replication is throttled.
idx: The index number of the replica stream.
networkencryption: A Boolean value that specifies if replication is encrypted.
synchronous: A Boolean value that specifies whether replication is synchronous or asynchronous.
networkcompression: The type of on-wire compression.
isUptodate: A Boolean value that specifies if the replica is up-to-date.
minPendingTS: The epoch time in milliseconds of the oldest message that has yet to be replicated.
maxPendingTS: The epoch time in milliseconds of the newest message that has yet to be replicated.
bytesPending: The number of bytes that have yet to be replicated.
bucketsPending: The number of buckets that have yet to be replicated.
uuid: The replica stream's universally unique identifier.