package etcdserverpb
Get desktop application:
View/edit binary Protocol Buffers messages
service Auth
rpc.proto:110rpc AuthDisable (, )
rpc.proto:115AuthDisable disables authentication.
message
rpc.proto:771(message has no fields)
message
rpc.proto:848optional header = 1
rpc AuthEnable (, )
rpc.proto:112AuthEnable enables authentication.
message
rpc.proto:768(message has no fields)
message
rpc.proto:844optional header = 1
rpc Authenticate (, )
rpc.proto:118Authenticate processes an authenticate request.
message
rpc.proto:774string name = 1
string password = 2
message
rpc.proto:852optional header = 1
string token = 2
token is an authorized token that can be used in succeeding RPCs
rpc RoleAdd (, )
rpc.proto:142RoleAdd adds a new role.
message
rpc.proto:812string name = 1
name is the name of the role to add to the authentication system.
message
rpc.proto:884optional header = 1
rpc RoleDelete (, )
rpc.proto:151RoleDelete deletes a specified role.
message
rpc.proto:827string role = 1
message
rpc.proto:906optional header = 1
rpc RoleGet (, )
rpc.proto:145RoleGet gets detailed role information.
message
rpc.proto:817string role = 1
message
rpc.proto:888optional header = 1
repeated perm = 2
rpc RoleGrantPermission (, )
rpc.proto:154RoleGrantPermission grants a permission of a specified key or range to a specified role.
message
rpc.proto:831string name = 1
name is the name of the role which will be granted the permission.
optional perm = 2
perm is the permission to grant to the role.
message
rpc.proto:910optional header = 1
rpc RoleList (, )
rpc.proto:148RoleList gets lists of all roles.
message
rpc.proto:824(message has no fields)
message
rpc.proto:894optional header = 1
repeated string roles = 2
rpc RoleRevokePermission (, )
rpc.proto:157RoleRevokePermission revokes a key or range permission of a specified role.
message
rpc.proto:838string role = 1
bytes key = 2
bytes range_end = 3
message
rpc.proto:914optional header = 1
rpc UserAdd (, )
rpc.proto:121UserAdd adds a new user.
message
rpc.proto:779string name = 1
string password = 2
message
rpc.proto:858optional header = 1
rpc UserChangePassword (, )
rpc.proto:133UserChangePassword changes the password of a specified user.
message
rpc.proto:793string name = 1
name is the name of the user whose password is being changed.
string password = 2
password is the new password for the user.
message
rpc.proto:872optional header = 1
rpc UserDelete (, )
rpc.proto:130UserDelete deletes a specified user.
message
rpc.proto:788string name = 1
name is the name of the user to delete.
message
rpc.proto:868optional header = 1
rpc UserGet (, )
rpc.proto:124UserGet gets detailed user information.
message
rpc.proto:784string name = 1
message
rpc.proto:862optional header = 1
repeated string roles = 2
rpc UserGrantRole (, )
rpc.proto:136UserGrant grants a role to a specified user.
message
rpc.proto:800string user = 1
user is the name of the user which should be granted a given role.
string role = 2
role is the name of the role to grant to the user.
message
rpc.proto:876optional header = 1
rpc UserList (, )
rpc.proto:127UserList gets a list of all users.
message
rpc.proto:821(message has no fields)
message
rpc.proto:900optional header = 1
repeated string users = 2
rpc UserRevokeRole (, )
rpc.proto:139UserRevokeRole revokes a role of specified user.
message
rpc.proto:807string name = 1
string role = 2
message
rpc.proto:880optional header = 1
service Cluster
rpc.proto:67rpc MemberAdd (, )
rpc.proto:69MemberAdd adds a member into the cluster.
message
rpc.proto:647repeated string peerURLs = 1
peerURLs is the list of URLs the added member will use to communicate with the cluster.
message
rpc.proto:652optional header = 1
optional member = 2
member is the member information for the added member.
repeated members = 3
members is a list of all members after adding the new member.
rpc MemberList (, )
rpc.proto:78MemberList lists all the members in the cluster.
message
rpc.proto:684(message has no fields)
message
rpc.proto:687optional header = 1
repeated members = 2
members is a list of all members associated with the cluster.
rpc MemberRemove (, )
rpc.proto:72MemberRemove removes an existing member from the cluster.
message
rpc.proto:660uint64 ID = 1
ID is the member ID of the member to remove.
message
rpc.proto:665optional header = 1
repeated members = 2
members is a list of all members after removing the member.
rpc MemberUpdate (, )
rpc.proto:75MemberUpdate updates the member configuration.
message
rpc.proto:671uint64 ID = 1
ID is the member ID of the member to update.
repeated string peerURLs = 2
peerURLs is the new list of URLs the member will use to communicate with the cluster.
message
rpc.proto:678optional header = 1
repeated members = 2
members is a list of all members after updating the member.
service KV
rpc.proto:12rpc Compact (, )
rpc.proto:35Compact 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.
message
rpc.proto:402CompactionRequest compacts the key-value store up to a given revision. All superseded keys with a revision less than the compaction revision will be removed.
int64 revision = 1
revision is the key-value store revision for the compaction operation.
bool physical = 2
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.
message
rpc.proto:411optional header = 1
rpc DeleteRange (, )
rpc.proto:24DeleteRange 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.
rpc Put (, )
rpc.proto:19Put 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.
rpc Range (, )
rpc.proto:14Range gets the keys in the range from the key-value store.
rpc Txn (, )
rpc.proto:30Txn 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.
service Lease
rpc.proto:47rpc LeaseGrant (, )
rpc.proto:51LeaseGrant 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.
message
rpc.proto:550int64 TTL = 1
TTL is the advisory time-to-live in seconds. Expired lease will return -1.
int64 ID = 2
ID is the requested ID for the lease. If ID is set to 0, the lessor chooses an ID.
message
rpc.proto:557optional header = 1
int64 ID = 2
ID is the lease ID for the granted lease.
int64 TTL = 3
TTL is the server chosen lease time-to-live in seconds.
string error = 4
rpc LeaseKeepAlive (stream , stream )
rpc.proto:58LeaseKeepAlive 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.
message
rpc.proto:591int64 ID = 1
ID is the lease ID for the lease to keep alive.
message
rpc.proto:596optional header = 1
int64 ID = 2
ID is the lease ID from the keep alive request.
int64 TTL = 3
TTL is the new time-to-live for the lease.
rpc LeaseLeases (, )
rpc.proto:64LeaseLeases lists all existing leases.
message
rpc.proto:623(message has no fields)
message
rpc.proto:631optional header = 1
repeated leases = 2
rpc LeaseRevoke (, )
rpc.proto:54LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.
message
rpc.proto:566int64 ID = 1
ID is the lease ID to revoke. When the ID is revoked, all associated keys will be deleted.
message
rpc.proto:571optional header = 1
rpc LeaseTimeToLive (, )
rpc.proto:61LeaseTimeToLive retrieves lease information.
message
rpc.proto:604int64 ID = 1
ID is the lease ID for the lease.
bool keys = 2
keys is true to query all the keys attached to this lease.
message
rpc.proto:611optional header = 1
int64 ID = 2
ID is the lease ID from the keep alive request.
int64 TTL = 3
TTL is the remaining TTL in seconds for the lease; the lease will expire in under TTL+1 seconds.
int64 grantedTTL = 4
GrantedTTL is the initial granted time in seconds upon lease creation/renewal.
repeated bytes keys = 5
Keys is the list of keys attached to this lease.
service Maintenance
rpc.proto:81rpc Alarm (, )
rpc.proto:83Alarm activates, deactivates, and queries alarms regarding cluster health.
message
rpc.proto:715AlarmRequest.AlarmAction action = 1
action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.
uint64 memberID = 2
memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.
AlarmType alarm = 3
alarm is the type of alarm to consider for this request.
message
rpc.proto:739optional header = 1
repeated alarms = 2
alarms is a list of alarms associated with the alarm request.
rpc Defragment (, )
rpc.proto:89Defragment defragments a member's backend database to recover storage space.
message
rpc.proto:693(message has no fields)
message
rpc.proto:696optional header = 1
rpc Hash (, )
rpc.proto:97Hash 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.
message
rpc.proto:415(message has no fields)
message
rpc.proto:431optional header = 1
uint32 hash = 2
hash is the hash value computed from the responding member's KV's backend.
rpc HashKV (, )
rpc.proto:101HashKV computes the hash of all MVCC keys up to a given revision. It only iterates "key" bucket in backend storage.
message
rpc.proto:418int64 revision = 1
revision is the key-value store revision for the hash operation.
message
rpc.proto:423optional header = 1
uint32 hash = 2
hash is the hash value computed from the responding member's MVCC keys up to a given revision.
int64 compact_revision = 3
compact_revision is the compacted revision of key-value store when hash begins.
rpc MoveLeader (, )
rpc.proto:107MoveLeader requests current leader node to transfer its leadership to transferee.
message
rpc.proto:700uint64 targetID = 1
targetID is the node ID for the new leader.
message
rpc.proto:705optional header = 1
rpc Snapshot (, stream )
rpc.proto:104Snapshot sends a snapshot of the entire backend from a member over a stream to a client.
message
rpc.proto:437(message has no fields)
message
rpc.proto:440optional header = 1
header has the current key-value store information. The first header in the snapshot stream indicates the point in time of the snapshot.
uint64 remaining_bytes = 2
remaining_bytes is the number of blob bytes to be sent after this message
bytes blob = 3
blob contains the next chunk of the snapshot in the snapshot stream.
rpc Status (, )
rpc.proto:86Status gets the status of the member.
message
rpc.proto:745(message has no fields)
message
rpc.proto:748optional header = 1
string version = 2
version is the cluster protocol version used by the responding member.
int64 dbSize = 3
dbSize is the size of the backend database physically allocated, in bytes, of the responding member.
uint64 leader = 4
leader is the member ID which the responding member believes is the current leader.
uint64 raftIndex = 5
raftIndex is the current raft committed index of the responding member.
uint64 raftTerm = 6
raftTerm is the current raft term of the responding member.
uint64 raftAppliedIndex = 7
raftAppliedIndex is the current raft applied index of the responding member.
repeated string errors = 8
errors contains alarm/health information and status.
int64 dbSizeInUse = 9
dbSizeInUse is the size of the backend database logically in use, in bytes, of the responding member.
service Watch
rpc.proto:38rpc Watch (stream , stream )
rpc.proto:44Watch 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.
message
rpc.proto:452oneof request_union
request_union is a request to either create a new watcher or cancel an existing watcher.
create_request = 1
cancel_request = 2
progress_request = 3
message
rpc.proto:516optional header = 1
int64 watch_id = 2
watch_id is the ID of the watcher that corresponds to the response.
bool created = 3
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 = 4
canceled is set to true if the response is for a cancel watch request. No further events will be sent to the canceled watcher.
int64 compact_revision = 5
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.
string cancel_reason = 6
cancel_reason indicates the reason for canceling the watcher.
bool fragment = 7
framgment is true if large watch response was split over multiple responses.
repeated events = 11
message
rpc.proto:732Used in:
uint64 memberID = 1
memberID is the ID of the member associated with the raised alarm.
AlarmType alarm = 2
alarm is the type of alarm which has been raised.
Used in:
GET = 0
ACTIVATE = 1
DEACTIVATE = 2
Used in: ,
NONE = 0
default, used to query if any alarm is active
NOSPACE = 1
space quota is exhausted
CORRUPT = 2
kv store corruption detected
message
rpc.proto:323Used in:
Compare.CompareResult result = 1
result is logical comparison operation for this comparison.
Compare.CompareTarget target = 2
target is the key-value field to inspect for the comparison.
bytes key = 3
key is the subject key for the comparison operation.
oneof target_union
int64 version = 4
version is the version of the given key
int64 create_revision = 5
create_revision is the creation revision of the given key
int64 mod_revision = 6
mod_revision is the last modified revision of the given key.
bytes value = 7
value is the value of the given key, in bytes.
int64 lease = 8
lease is the lease id of the given key.
leave room for more target_union field tags, jump to 64
bytes range_end = 64
range_end compares the given target to all keys in the range [key, range_end). See RangeRequest for more details on key ranges.
TODO: fill out with most of the rest of RangeRequest fields when needed.
Used in:
EQUAL = 0
GREATER = 1
LESS = 2
NOT_EQUAL = 3
Used in:
VERSION = 0
CREATE = 1
MOD = 2
VALUE = 3
LEASE = 4
message
rpc.proto:280Used as request type in: KV.DeleteRange
Used as field type in:
bytes key = 1
key is the first key to delete in the range.
bytes range_end = 2
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.
bool prev_kv = 3
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.
message
rpc.proto:295Used as response type in: KV.DeleteRange
Used as field type in:
optional header = 1
int64 deleted = 2
deleted is the number of keys deleted by the delete range request.
repeated prev_kvs = 3
if prev_kv is set in the request, the previous key-value pairs will be returned.
message
rpc.proto:575Used in:
int64 ID = 1
ID is the lease ID to checkpoint.
int64 remaining_TTL = 2
Remaining_TTL is the remaining time until expiry of the lease.
message
rpc.proto:583repeated checkpoints = 1
message
rpc.proto:587optional header = 1
message
rpc.proto:626Used in:
int64 ID = 1
TODO: int64 TTL = 2;
message
rpc.proto:636Used in: , , ,
uint64 ID = 1
ID is the member ID for this member.
string name = 2
name is the human-readable name of the member. If the member is not started, the name will be an empty string.
repeated string peerURLs = 3
peerURLs is the list of URLs the member exposes to the cluster for communication.
repeated string clientURLs = 4
clientURLs is the list of URLs the member exposes to clients for communication. If the member is not started, clientURLs will be empty.
message
rpc.proto:252Used as request type in: KV.Put
Used as field type in:
bytes key = 1
key is the key, in bytes, to put into the key-value store.
bytes value = 2
value is the value, in bytes, to associate with the key in the key-value store.
int64 lease = 3
lease is the lease ID to associate with the key in the key-value store. A lease value of 0 indicates no lease.
bool prev_kv = 4
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 = 5
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 = 6
If ignore_lease is set, etcd updates the key using its current lease. Returns an error if the key does not exist.
message
rpc.proto:274Used as response type in: KV.Put
Used as field type in:
optional header = 1
optional prev_kv = 2
if prev_kv is set in the request, the previous key-value pair will be returned.
message
rpc.proto:174Used as request type in: KV.Range
Used as field type in:
bytes key = 1
key is the first key for the range. If range_end is not given, the request only looks up key.
bytes range_end = 2
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.
int64 limit = 3
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 = 4
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.
RangeRequest.SortOrder sort_order = 5
sort_order is the order for returned sorted results.
RangeRequest.SortTarget sort_target = 6
sort_target is the key-value field to use for sorting.
bool serializable = 7
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 = 8
keys_only when set returns only the keys and not the values.
bool count_only = 9
count_only when set returns only the count of the keys in the range.
int64 min_mod_revision = 10
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 = 11
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 = 12
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 = 13
max_create_revision is the upper bound for returned key create revisions; all keys with greater create revisions will be filtered away.
Used in:
NONE = 0
default, no sorting
ASCEND = 1
lowest target value first
DESCEND = 2
highest target value first
Used in:
KEY = 0
VERSION = 1
CREATE = 2
MOD = 3
VALUE = 4
message
rpc.proto:241Used as response type in: KV.Range
Used as field type in:
optional header = 1
repeated kvs = 2
kvs is the list of key-value pairs matched by the range request. kvs is empty when count is requested.
bool more = 3
more indicates if there are more keys to return in the requested range.
int64 count = 4
count is set to the number of keys within the range when requested.
message
rpc.proto:303Used in:
oneof request
request is a union of request types accepted by a transaction.
request_range = 1
request_put = 2
request_delete_range = 3
request_txn = 4
message
rpc.proto:160Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
uint64 cluster_id = 1
cluster_id is the ID of the cluster which sent the response.
uint64 member_id = 2
member_id is the ID of the member which sent the response.
int64 revision = 3
revision is the key-value store revision when the request was applied. For watch progress responses, the header.revision indicates progress. All future events recieved in this stream are guaranteed to have a higher revision number than the header.revision number.
uint64 raft_term = 4
raft_term is the raft term when the request was applied.
message
rpc.proto:313Used in:
oneof response
response is a union of response types returned by a transaction.
response_range = 1
response_put = 2
response_delete_range = 3
response_txn = 4
message
rpc.proto:378From google paxosdb paper: Our implementation hinges around a powerful primitive which we call MultiOp. All other database operations except for iteration are implemented as a single call to MultiOp. A MultiOp is applied atomically and consists of three components: 1. A list of tests called guard. Each test in guard checks a single entry in the database. It may check for the absence or presence of a value, or compare with a given value. Two different tests in the guard may apply to the same or different entries in the database. All tests in the guard are applied and MultiOp returns the results. If all tests are true, MultiOp executes t op (see item 2 below), otherwise it executes f op (see item 3 below). 2. A list of database operations called t op. Each operation in the list is either an insert, delete, or lookup operation, and applies to a single database entry. Two different operations in the list may apply to the same or different entries in the database. These operations are executed if guard evaluates to true. 3. A list of database operations called f op. Like t op, but executed if guard evaluates to false.
Used as request type in: KV.Txn
Used as field type in:
repeated compare = 1
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.
repeated success = 2
success is a list of requests which will be applied when compare evaluates to true.
repeated failure = 3
failure is a list of requests which will be applied when compare evaluates to false.
message
rpc.proto:391Used as response type in: KV.Txn
Used as field type in:
optional header = 1
bool succeeded = 2
succeeded is set to true if the compare evaluated to true or false otherwise.
repeated responses = 3
responses is a list of responses corresponding to the results from applying success if succeeded is true or failure if succeeded is false.
message
rpc.proto:506Used in:
int64 watch_id = 1
watch_id is the watcher id to cancel so that no more events are transmitted.
message
rpc.proto:461Used in:
bytes key = 1
key is the key to register for watching.
bytes range_end = 2
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.
int64 start_revision = 3
start_revision is an optional revision to watch from (inclusive). No start_revision is "now".
bool progress_notify = 4
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.
repeated WatchCreateRequest.FilterType filters = 5
filters filter the events at server side before it sends back to the watcher.
bool prev_kv = 6
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.
int64 watch_id = 7
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.
bool fragment = 8
fragment enables splitting large revisions into multiple watch responses.
Used in:
NOPUT = 0
filter out put event.
NODELETE = 1
filter out delete event.
message
rpc.proto:513Requests the a watch stream progress status be sent in the watch response stream as soon as possible.
Used in:
(message has no fields)