Patroni

AuthEnable

AuthEnableRequest

AuthEnableResponse

AuthEnable enables authentication.

AuthDisable

AuthDisableRequest

AuthDisableResponse

AuthDisable disables authentication.

AuthStatus

AuthStatusRequest

AuthStatusResponse

AuthStatus displays authentication status.

Authenticate

AuthenticateRequest

AuthenticateResponse

Authenticate processes an authenticate request.

UserAdd

AuthUserAddRequest

AuthUserAddResponse

UserAdd adds a new user. User name cannot be empty.

UserGet

AuthUserGetRequest

AuthUserGetResponse

UserGet gets detailed user information.

UserList

AuthUserListRequest

AuthUserListResponse

UserList gets a list of all users.

UserDelete

AuthUserDeleteRequest

AuthUserDeleteResponse

UserDelete deletes a specified user.

UserChangePassword

AuthUserChangePasswordRequest

AuthUserChangePasswordResponse

UserChangePassword changes the password of a specified user.

UserGrantRole

AuthUserGrantRoleRequest

AuthUserGrantRoleResponse

UserGrant grants a role to a specified user.

UserRevokeRole

AuthUserRevokeRoleRequest

AuthUserRevokeRoleResponse

UserRevokeRole revokes a role of specified user.

RoleAdd

AuthRoleAddRequest

AuthRoleAddResponse

RoleAdd adds a new role. Role name cannot be empty.

RoleGet

AuthRoleGetRequest

AuthRoleGetResponse

RoleGet gets detailed role information.

RoleList

AuthRoleListRequest

AuthRoleListResponse

RoleList gets lists of all roles.

RoleDelete

AuthRoleDeleteRequest

AuthRoleDeleteResponse

RoleDelete deletes a specified role.

RoleGrantPermission

AuthRoleGrantPermissionRequest

AuthRoleGrantPermissionResponse

RoleGrantPermission grants a permission of a specified key or range to a specified role.

RoleRevokePermission

AuthRoleRevokePermissionRequest

AuthRoleRevokePermissionResponse

RoleRevokePermission revokes a key or range permission of a specified role.

MemberAdd

MemberAddRequest

MemberAddResponse

MemberAdd adds a member into the cluster.

MemberRemove

MemberRemoveRequest

MemberRemoveResponse

MemberRemove removes an existing member from the cluster.

MemberUpdate

MemberUpdateRequest

MemberUpdateResponse

MemberUpdate updates the member configuration.

MemberList

MemberListRequest

MemberListResponse

MemberList lists all the members in the cluster.

MemberPromote

MemberPromoteRequest

MemberPromoteResponse

MemberPromote promotes a member from raft learner (non-voting) to raft voting member.

Range

RangeRequest

RangeResponse

Range gets the keys in the range from the key-value store.

Put

PutRequest

PutResponse

Put puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.

DeleteRange

DeleteRangeRequest

DeleteRangeResponse

DeleteRange deletes the given range from the key-value store. A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.

Txn

TxnRequest

TxnResponse

Txn processes multiple requests in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.

Compact

CompactionRequest

CompactionResponse

Compact compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.

LeaseGrant

LeaseGrantRequest

LeaseGrantResponse

LeaseGrant creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.

LeaseRevoke

LeaseRevokeRequest

LeaseRevokeResponse

LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.

LeaseKeepAlive

LeaseKeepAliveRequest

LeaseKeepAliveResponse

LeaseKeepAlive keeps the lease alive by streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client.

LeaseTimeToLive

LeaseTimeToLiveRequest

LeaseTimeToLiveResponse

LeaseTimeToLive retrieves lease information.

LeaseLeases

LeaseLeasesRequest

LeaseLeasesResponse

LeaseLeases lists all existing leases.

Alarm

AlarmRequest

AlarmResponse

Alarm activates, deactivates, and queries alarms regarding cluster health.

Status

StatusRequest

StatusResponse

Status gets the status of the member.

Defragment

DefragmentRequest

DefragmentResponse

Defragment defragments a member’s backend database to recover storage space.

Hash

HashRequest

HashResponse

Hash computes the hash of whole backend keyspace, including key, lease, and other buckets in storage. This is designed for testing ONLY! Do not rely on this in production with ongoing transactions, since Hash operation does not hold MVCC locks. Use “HashKV” API instead for “key” bucket consistency checks.

HashKV

HashKVRequest

HashKVResponse

HashKV computes the hash of all MVCC keys up to a given revision. It only iterates “key” bucket in backend storage.

Snapshot

SnapshotRequest

SnapshotResponse

Snapshot sends a snapshot of the entire backend from a member over a stream to a client.

MoveLeader

MoveLeaderRequest

MoveLeaderResponse

MoveLeader requests current leader node to transfer its leadership to transferee.

Downgrade

DowngradeRequest

DowngradeResponse

Downgrade requests downgrades, verifies feasibility or cancels downgrade on the cluster version. Supported since etcd 3.5.

Watch

WatchRequest

WatchResponse

Watch watches for events happening or that have happened. Both input and output are streams; the input stream is for creating and canceling watchers and the output stream sends events. One watch RPC can watch on multiple key ranges, streaming events for several watches at once. The entire event history can be watched starting from the last compaction revision.

memberID

memberID is the ID of the member associated with the raised alarm.

uint64

alarm

alarm is the type of alarm which has been raised.

AlarmType

action

action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.

AlarmAction

memberID

memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.

uint64

alarm

alarm is the type of alarm to consider for this request.

AlarmType

header

ResponseHeader

alarms

alarms is a list of alarms associated with the alarm request.

(slice of) AlarmMember

header

ResponseHeader

header

ResponseHeader

name

name is the name of the role to add to the authentication system.

string

header

ResponseHeader

role

string

header

ResponseHeader

role

string

header

ResponseHeader

perm

(slice of) authpb.Permission

name

name is the name of the role which will be granted the permission.

string

perm

perm is the permission to grant to the role.

authpb.Permission

header

ResponseHeader

header

ResponseHeader

roles

(slice of) string

role

string

key

bytes

range_end

bytes

header

ResponseHeader

header

ResponseHeader

enabled

bool

authRevision

authRevision is the current revision of auth store

uint64

name

string

password

string

options

authpb.UserAddOptions

hashedPassword

string

header

ResponseHeader

name

name is the name of the user whose password is being changed.

string

password

password is the new password for the user. Note that this field will be removed in the API layer.

string

hashedPassword

hashedPassword is the new password for the user. Note that this field will be initialized in the API layer.

string

header

ResponseHeader

name

name is the name of the user to delete.

string

header

ResponseHeader

name

string

header

ResponseHeader

roles

(slice of) string

user

user is the name of the user which should be granted a given role.

string

role

role is the name of the role to grant to the user.

string

header

ResponseHeader

header

ResponseHeader

users

(slice of) string

name

string

role

string

header

ResponseHeader

name

string

password

string

header

ResponseHeader

token

token is an authorized token that can be used in succeeding RPCs

string

revision

revision is the key-value store revision for the compaction operation.

int64

physical

physical is set so the RPC will wait until the compaction is physically applied to the local database such that compacted entries are totally removed from the backend database.

bool

header

ResponseHeader

result

result is logical comparison operation for this comparison.

CompareResult

target

target is the key-value field to inspect for the comparison.

CompareTarget

key

key is the subject key for the comparison operation.

bytes

target_union

oneof

version

version is the version of the given key

int64

create_revision

create_revision is the creation revision of the given key

int64

mod_revision

mod_revision is the last modified revision of the given key.

int64

value

value is the value of the given key, in bytes.

bytes

lease

lease is the lease id of the given key.

int64

range_end

range_end compares the given target to all keys in the range [key, range_end). See RangeRequest for more details on key ranges.

bytes

header

ResponseHeader

key

key is the first key to delete in the range.

bytes

range_end

range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is ‘\0’, the range is all keys greater than or equal to the key argument.

bytes

prev_kv

If prev_kv is set, etcd gets the previous key-value pairs before deleting it. The previous key-value pairs will be returned in the delete response.

bool

header

ResponseHeader

deleted

deleted is the number of keys deleted by the delete range request.

int64

prev_kvs

if prev_kv is set in the request, the previous key-value pairs will be returned.

(slice of) mvccpb.KeyValue

action

action is the kind of downgrade request to issue. The action may VALIDATE the target version, DOWNGRADE the cluster version, or CANCEL the current downgrading job.

DowngradeAction

version

version is the target version to downgrade.

string

header

ResponseHeader

version

version is the current cluster version.

string

revision

revision is the key-value store revision for the hash operation.

int64

header

ResponseHeader

hash

hash is the hash value computed from the responding member’s MVCC keys up to a given revision.

uint32

compact_revision

compact_revision is the compacted revision of key-value store when hash begins.

int64

header

ResponseHeader

hash

hash is the hash value computed from the responding member’s KV’s backend.

uint32

ID

ID is the lease ID to checkpoint.

int64

remaining_TTL

Remaining_TTL is the remaining time until expiry of the lease.

int64

checkpoints

(slice of) LeaseCheckpoint

header

ResponseHeader

TTL

TTL is the advisory time-to-live in seconds. Expired lease will return -1.

int64

ID

ID is the requested ID for the lease. If ID is set to 0, the lessor chooses an ID.

int64

header

ResponseHeader

ID

ID is the lease ID for the granted lease.

int64

TTL

TTL is the server chosen lease time-to-live in seconds.

int64

error

string

ID

ID is the lease ID for the lease to keep alive.

int64

header

ResponseHeader

ID

ID is the lease ID from the keep alive request.

int64

TTL

TTL is the new time-to-live for the lease.

int64

header

ResponseHeader

leases

(slice of) LeaseStatus

ID

ID is the lease ID to revoke. When the ID is revoked, all associated keys will be deleted.

int64

header

ResponseHeader

ID

int64

ID

ID is the lease ID for the lease.

int64

keys

keys is true to query all the keys attached to this lease.

bool

header

ResponseHeader

ID

ID is the lease ID from the keep alive request.

int64

TTL

TTL is the remaining TTL in seconds for the lease; the lease will expire in under TTL+1 seconds.

int64

grantedTTL

GrantedTTL is the initial granted time in seconds upon lease creation/renewal.

int64

keys

Keys is the list of keys attached to this lease.

(slice of) bytes

ID

ID is the member ID for this member.

uint64

name

name is the human-readable name of the member. If the member is not started, the name will be an empty string.

string

peerURLs

peerURLs is the list of URLs the member exposes to the cluster for communication.

(slice of) string

clientURLs

clientURLs is the list of URLs the member exposes to clients for communication. If the member is not started, clientURLs will be empty.

(slice of) string

isLearner

isLearner indicates if the member is raft learner.

bool

peerURLs

peerURLs is the list of URLs the added member will use to communicate with the cluster.

(slice of) string

isLearner

isLearner indicates if the added member is raft learner.

bool

header

ResponseHeader

member

member is the member information for the added member.

Member

members

members is a list of all members after adding the new member.

(slice of) Member

linearizable

bool

header

ResponseHeader

members

members is a list of all members associated with the cluster.

(slice of) Member

ID

ID is the member ID of the member to promote.

uint64

header

ResponseHeader

members

members is a list of all members after promoting the member.

(slice of) Member

ID

ID is the member ID of the member to remove.

uint64

header

ResponseHeader

members

members is a list of all members after removing the member.

(slice of) Member

ID

ID is the member ID of the member to update.

uint64

peerURLs

peerURLs is the new list of URLs the member will use to communicate with the cluster.

(slice of) string

header

ResponseHeader

members

members is a list of all members after updating the member.

(slice of) Member

targetID

targetID is the node ID for the new leader.

uint64

header

ResponseHeader

key

key is the key, in bytes, to put into the key-value store.

bytes

value

value is the value, in bytes, to associate with the key in the key-value store.

bytes

lease

lease is the lease ID to associate with the key in the key-value store. A lease value of 0 indicates no lease.

int64

prev_kv

If prev_kv is set, etcd gets the previous key-value pair before changing it. The previous key-value pair will be returned in the put response.

bool

ignore_value

If ignore_value is set, etcd updates the key using its current value. Returns an error if the key does not exist.

bool

ignore_lease

If ignore_lease is set, etcd updates the key using its current lease. Returns an error if the key does not exist.

bool

header

ResponseHeader

prev_kv

if prev_kv is set in the request, the previous key-value pair will be returned.

mvccpb.KeyValue

key

key is the first key for the range. If range_end is not given, the request only looks up key.

bytes

range_end

range_end is the upper bound on the requested range [key, range_end). If range_end is ‘\0’, the range is all keys >= key. If range_end is key plus one (e.g., “aa”+1 == “ab”, “a\xff”+1 == “b”), then the range request gets all keys prefixed with key. If both key and range_end are ‘\0’, then the range request returns all keys.

bytes

limit

limit is a limit on the number of keys returned for the request. When limit is set to 0, it is treated as no limit.

int64

revision

revision is the point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompacted is returned as a response.

int64

sort_order

sort_order is the order for returned sorted results.

SortOrder

sort_target

sort_target is the key-value field to use for sorting.

SortTarget

serializable

serializable sets the range request to use serializable member-local reads. Range requests are linearizable by default; linearizable requests have higher latency and lower throughput than serializable requests but reflect the current consensus of the cluster. For better performance, in exchange for possible stale reads, a serializable range request is served locally without needing to reach consensus with other nodes in the cluster.

bool

keys_only

keys_only when set returns only the keys and not the values.

bool

count_only

count_only when set returns only the count of the keys in the range.

bool

min_mod_revision

min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.

int64

max_mod_revision

max_mod_revision is the upper bound for returned key mod revisions; all keys with greater mod revisions will be filtered away.

int64

min_create_revision

min_create_revision is the lower bound for returned key create revisions; all keys with lesser create revisions will be filtered away.

int64

max_create_revision

max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.

int64

header

ResponseHeader

kvs

kvs is the list of key-value pairs matched by the range request. kvs is empty when count is requested.

(slice of) mvccpb.KeyValue

more

more indicates if there are more keys to return in the requested range.

bool

count

count is set to the number of keys within the range when requested.

int64

request

request is a union of request types accepted by a transaction.

oneof

request_range

RangeRequest

request_put

PutRequest

request_delete_range

DeleteRangeRequest

request_txn

TxnRequest

cluster_id

cluster_id is the ID of the cluster which sent the response.

uint64

member_id

member_id is the ID of the member which sent the response.

uint64

revision

revision is the key-value store revision when the request was applied. For watch progress responses, the header.revision indicates progress. All future events received in this stream are guaranteed to have a higher revision number than the header.revision number.

int64

raft_term

raft_term is the raft term when the request was applied.

uint64

response

response is a union of response types returned by a transaction.

oneof

response_range

RangeResponse

response_put

PutResponse

response_delete_range

DeleteRangeResponse

response_txn

TxnResponse

header

header has the current key-value store information. The first header in the snapshot stream indicates the point in time of the snapshot.

ResponseHeader

remaining_bytes

remaining_bytes is the number of blob bytes to be sent after this message

uint64

blob

blob contains the next chunk of the snapshot in the snapshot stream.

bytes

header

ResponseHeader

version

version is the cluster protocol version used by the responding member.

string

dbSize

dbSize is the size of the backend database physically allocated, in bytes, of the responding member.

int64

leader

leader is the member ID which the responding member believes is the current leader.

uint64

raftIndex

raftIndex is the current raft committed index of the responding member.

uint64

raftTerm

raftTerm is the current raft term of the responding member.

uint64

raftAppliedIndex

raftAppliedIndex is the current raft applied index of the responding member.

uint64

errors

errors contains alarm/health information and status.

(slice of) string

dbSizeInUse

dbSizeInUse is the size of the backend database logically in use, in bytes, of the responding member.

int64

isLearner

isLearner indicates if the member is raft learner.

bool

compare

compare is a list of predicates representing a conjunction of terms. If the comparisons succeed, then the success requests will be processed in order, and the response will contain their respective responses in order. If the comparisons fail, then the failure requests will be processed in order, and the response will contain their respective responses in order.

(slice of) Compare

success

success is a list of requests which will be applied when compare evaluates to true.

(slice of) RequestOp

failure

failure is a list of requests which will be applied when compare evaluates to false.

(slice of) RequestOp

header

ResponseHeader

succeeded

succeeded is set to true if the compare evaluated to true or false otherwise.

bool

responses

responses is a list of responses corresponding to the results from applying success if succeeded is true or failure if succeeded is false.

(slice of) ResponseOp

watch_id

watch_id is the watcher id to cancel so that no more events are transmitted.

int64

key

key is the key to register for watching.

bytes

range_end

range_end is the end of the range [key, range_end) to watch. If range_end is not given, only the key argument is watched. If range_end is equal to ‘\0’, all keys greater than or equal to the key argument are watched. If the range_end is one bit larger than the given key, then all keys with the prefix (the given key) will be watched.

bytes

start_revision

start_revision is an optional revision to watch from (inclusive). No start_revision is “now”.

int64

progress_notify

progress_notify is set so that the etcd server will periodically send a WatchResponse with no events to the new watcher if there are no recent events. It is useful when clients wish to recover a disconnected watcher starting from a recent known revision. The etcd server may decide how often it will send notifications based on current load.

bool

filters

filters filter the events at server side before it sends back to the watcher.

(slice of) FilterType

prev_kv

If prev_kv is set, created watcher gets the previous KV before the event happens. If the previous KV is already compacted, nothing will be returned.

bool

watch_id

If watch_id is provided and non-zero, it will be assigned to this watcher. Since creating a watcher in etcd is not a synchronous operation, this can be used ensure that ordering is correct when creating multiple watchers on the same stream. Creating a watcher with an ID already in use on the stream will cause an error to be returned.

int64

fragment

fragment enables splitting large revisions into multiple watch responses.

bool

request_union

request_union is a request to either create a new watcher or cancel an existing watcher.

oneof

create_request

WatchCreateRequest

cancel_request

WatchCancelRequest

progress_request

WatchProgressRequest

header

ResponseHeader

watch_id

watch_id is the ID of the watcher that corresponds to the response.

int64

created

created is set to true if the response is for a create watch request. The client should record the watch_id and expect to receive events for the created watcher from the same stream. All events sent to the created watcher will attach with the same watch_id.

bool

canceled

canceled is set to true if the response is for a cancel watch request. No further events will be sent to the canceled watcher.

bool

compact_revision

compact_revision is set to the minimum index if a watcher tries to watch at a compacted index. This happens when creating a watcher at a compacted revision or the watcher cannot catch up with the progress of the key-value store. The client should treat the watcher as canceled and should not try to create any watcher with the same start_revision again.

int64

cancel_reason

cancel_reason indicates the reason for canceling the watcher.

string

fragment

framgment is true if large watch response was split over multiple responses.

bool

events

(slice of) mvccpb.Event

type

type is the kind of event. If type is a PUT, it indicates new data has been stored to the key. If type is a DELETE, it indicates the key was deleted.

EventType

kv

kv holds the KeyValue for the event. A PUT event contains current kv pair. A PUT event with kv.Version=1 indicates the creation of a key. A DELETE/EXPIRE event contains the deleted key with its modification revision set to the revision of deletion.

KeyValue

prev_kv

prev_kv holds the key-value pair before the event happens.

KeyValue

key

key is the key in bytes. An empty key is not allowed.

bytes

create_revision

create_revision is the revision of last creation on this key.

int64

mod_revision

mod_revision is the revision of last modification on this key.

int64

version

version is the version of the key. A deletion resets the version to zero and any modification of the key increases its version.

int64

value

value is the value held by the key, in bytes.

bytes

lease

lease is the ID of the lease that attached to key. When the attached lease expires, the key will be deleted. If lease is 0, then no lease is attached to the key.

int64

ID

int64

TTL

int64

RemainingTTL

int64

LeaseTimeToLiveRequest

etcdserverpb.LeaseTimeToLiveRequest

LeaseTimeToLiveResponse

etcdserverpb.LeaseTimeToLiveResponse

permType

Type

key

bytes

range_end

bytes

name

bytes

keyPermission

(slice of) Permission

name

bytes

password

bytes

roles

(slice of) string

options

UserAddOptions

no_password

bool