Skip to content

KR.ADMIN DESCRIBE-MEMBER

Returns metadata for the local cluster member.

KR.ADMIN DESCRIBE-MEMBER

None.

RESP3 map containing the local member’s properties:

FieldTypeDescription
member_idstringID of this member
statusstringMember status: RUNNING, UNAVAILABLE, STOPPED, or UNKNOWN
process_idstringBase32-hex encoded Versionstamp, unique per process lifetime
external_advertisearray of stringsAddresses clients connect to, host:port, preferred entry first
internal_advertisearray of stringsAddresses other cluster members connect to, host:port, preferred entry first
latest_heartbeatintegerMonotonically increasing heartbeat counter, incremented by one on each heartbeat interval. 0 if no heartbeat has been recorded yet

Unlike FIND-MEMBER, this command includes the member_id field, since the caller may not know the local member’s identity.

Returns the local member’s properties as a RESP3 map. Useful for health checks and operational scripts.

Requires cluster initialization.

Argument errors:

Error CodeError messageCause
ERRinvalid number of parameters-

Cluster errors:

Error CodeError messageCause
ERRcluster has not been initialized yet-

Describe the local member:

127.0.0.1:3320> KR.ADMIN DESCRIBE-MEMBER
1# "member_id" => "006cdc459c59e600c76494e8388857fc3cba2fa8"
2# "status" => "RUNNING"
3# "process_id" => "A1B2C3D4E5F6G7H8I9J0"
4# "external_advertise" =>
1) "10.0.0.1:5484"
5# "internal_advertise" =>
1) "10.0.0.1:3320"
6# "latest_heartbeat" => (integer) 31404

Error: extra parameters

127.0.0.1:3320> KR.ADMIN DESCRIBE-MEMBER foo
(error) ERR invalid number of parameters