10.14 Describing a ReplicaSet

This section describes how to retrieve a JSON object describing the structure of a ReplicaSet using replicaSet.describe().

To retrieve the description of the ReplicaSet, you must be connected to one of the ReplicaSet members. The following data is returned:

• name: the name of the ReplicaSet.

• topology: an array containing the following information on each member of the ReplicaSet:

  • address: the instance address (host:port).

  • label: the instance identifier.

  • instanceRole: the instance role, either PRIMARY, SECONDARY, or null if invalidated.