https://pig.center/zh/docs/etcd/dev-guide/Recent content in 开发指南 on PIG.CENTERHugozh-CNTue, 08 Sep 2026 21:29:01 +0800https://pig.center/zh/docs/etcd/dev-guide/discovery_protocol/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/discovery_protocol/<p>发现服务协议有助于新 etcd 成员在集群引导阶段通过共享的发现 URL 发现集群中的所有其他成员。</p> <p>发现服务协议仅在集群引导阶段使用，不可用于运行时重配置或集群监控。</p>https://pig.center/zh/docs/etcd/dev-guide/local_cluster/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/local_cluster/<p>对于测试和开发部署，最快捷简便的方式是配置本地集群。对于生产部署，请参考 <a href="https://pig.center/zh/docs/etcd/op-guide/clustering/">clustering</a> 章节。</p> <h2 id="local-standalone-cluster">本地独立集群 </h2> <h3 id="starting-a-cluster">启动集群 </h3> <p>运行以下命令以将 etcd 集群部署为独立集群：</p>https://pig.center/zh/docs/etcd/dev-guide/interacting_v3/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/interacting_v3/<p>用户通常通过设置或获取键的值来与 etcd 交互。本节介绍如何使用 etcdctl（用于与 etcd 服务器交互的命令行工具）实现这一操作。此处描述的概念同样适用于 gRPC API 或客户端库 API。</p>https://pig.center/zh/docs/etcd/dev-guide/api_grpc_gateway/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/api_grpc_gateway/<p>etcd v3 使用 <a href="https://www.grpc.io/">gRPC</a> 作为其消息协议。etcd 项目包含一个基于 gRPC 的 <a href="https://github.com/etcd-io/etcd/tree/main/client/v3">Go 客户端</a> ，以及一个命令行工具 <a href="https://github.com/etcd-io/etcd/tree/main/etcdctl">etcdctl</a> ，用于通过 gRPC 与 etcd 集群通信。对于不支持 gRPC 的语言，etcd 提供一个 JSON <a href="https://github.com/grpc-ecosystem/grpc-gateway">gRPC 网关</a> 。该网关提供一个 RESTful 代理，可将 HTTP/JSON 请求转换为 gRPC 消息。</p>https://pig.center/zh/docs/etcd/dev-guide/grpc_naming/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/grpc_naming/<p>etcd 提供了一个 gRPC 解析器，用于支持一种替代名称系统，该系统从 etcd 获取端点以发现 gRPC 服务。其底层机制基于监听以服务名称为前缀的键的更新。</p> <p>请注意，此功能为实验性功能，因为它依赖于 <a href="https://github.com/grpc/grpc-go/tree/4cedec40eb2ccfbe3f56bb15e894903111ada2d2/resolver">google.golang.org/grpc/resolver</a> 包，而该包在 grpc-go 中仍处于实验阶段。</p>https://pig.center/zh/docs/etcd/dev-guide/golang_embed_pkg/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/golang_embed_pkg/<p>etcd <code>embed</code> go 包提供了一种简便方式，可将 etcd 服务器直接嵌入应用程序。</p> <p>有关详细信息，请参见 <a href="https://pkg.go.dev/go.etcd.io/etcd/server/v3/embed">embed 包文档</a> 。</p>https://pig.center/zh/docs/etcd/dev-guide/limit/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/limit/<h2 id="request-size-limit">请求大小限制 </h2> <p>etcd 专为处理典型的元数据类小规模键值对而设计。虽然较大请求也能正常工作，但可能增加其他请求的延迟。默认情况下，任何请求的最大大小为 1.5 MiB。此限制可通过 etcd 服务器的 <code>--max-request-bytes</code> 标志进行配置。</p>https://pig.center/zh/docs/etcd/dev-guide/features/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/features/<p>本文概述了 etcd 的各项功能，旨在帮助用户更好地理解这些功能及其相关弃用流程。若想了解 etcd 功能的开发方式，请参阅 <a href="https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/features.md">开发指南</a> 。</p> <p>etcd 功能分为三个阶段：实验性、稳定和不安全。可通过运行 <code>etcd --help</code> 获取功能列表。</p>https://pig.center/zh/docs/etcd/dev-guide/api_reference_v3/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/api_reference_v3/<p>本文 API 参考由命名的 <code>.proto</code> 文件自动生成。</p> <h5 id="service-auth-apietcdserverpbrpcproto">服务 <code>Auth</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>AuthEnable</td> <td>AuthEnableRequest</td> <td>AuthEnableResponse</td> <td>AuthEnable 启用身份认证。</td> </tr> <tr> <td>AuthDisable</td> <td>AuthDisableRequest</td> <td>AuthDisableResponse</td> <td>AuthDisable 禁用身份认证。</td> </tr> <tr> <td>AuthStatus</td> <td>AuthStatusRequest</td> <td>AuthStatusResponse</td> <td>AuthStatus 显示身份认证状态。</td> </tr> <tr> <td>Authenticate</td> <td>AuthenticateRequest</td> <td>AuthenticateResponse</td> <td>Authenticate 处理身份认证请求。</td> </tr> <tr> <td>UserAdd</td> <td>AuthUserAddRequest</td> <td>AuthUserAddResponse</td> <td>UserAdd 添加新用户。用户名不能为空。</td> </tr> <tr> <td>UserGet</td> <td>AuthUserGetRequest</td> <td>AuthUserGetResponse</td> <td>UserGet 获取用户详细信息。</td> </tr> <tr> <td>UserList</td> <td>AuthUserListRequest</td> <td>AuthUserListResponse</td> <td>UserList 获取所有用户的列表。</td> </tr> <tr> <td>UserDelete</td> <td>AuthUserDeleteRequest</td> <td>AuthUserDeleteResponse</td> <td>UserDelete 删除指定用户。</td> </tr> <tr> <td>UserChangePassword</td> <td>AuthUserChangePasswordRequest</td> <td>AuthUserChangePasswordResponse</td> <td>UserChangePassword 更改指定用户的密码。</td> </tr> <tr> <td>UserGrantRole</td> <td>AuthUserGrantRoleRequest</td> <td>AuthUserGrantRoleResponse</td> <td>UserGrant 为指定用户授予角色。</td> </tr> <tr> <td>UserRevokeRole</td> <td>AuthUserRevokeRoleRequest</td> <td>AuthUserRevokeRoleResponse</td> <td>UserRevokeRole 撤销指定用户的指定角色。</td> </tr> <tr> <td>RoleAdd</td> <td>AuthRoleAddRequest</td> <td>AuthRoleAddResponse</td> <td>RoleAdd 添加新角色。角色名不能为空。</td> </tr> <tr> <td>RoleGet</td> <td>AuthRoleGetRequest</td> <td>AuthRoleGetResponse</td> <td>RoleGet 获取角色详细信息。</td> </tr> <tr> <td>RoleList</td> <td>AuthRoleListRequest</td> <td>AuthRoleListResponse</td> <td>RoleList 获取所有角色的列表。</td> </tr> <tr> <td>RoleDelete</td> <td>AuthRoleDeleteRequest</td> <td>AuthRoleDeleteResponse</td> <td>RoleDelete 删除指定角色。</td> </tr> <tr> <td>RoleGrantPermission</td> <td>AuthRoleGrantPermissionRequest</td> <td>AuthRoleGrantPermissionResponse</td> <td>RoleGrantPermission 为指定角色授予指定键或范围的权限。</td> </tr> <tr> <td>RoleRevokePermission</td> <td>AuthRoleRevokePermissionRequest</td> <td>AuthRoleRevokePermissionResponse</td> <td>RoleRevokePermission 撤销指定角色的指定键或范围的权限。</td> </tr> </tbody> </table> </div> <h5 id="service-cluster-apietcdserverpbrpcproto">服务 <code>Cluster</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>MemberAdd</td> <td>MemberAddRequest</td> <td>MemberAddResponse</td> <td>MemberAdd 将成员添加至集群。</td> </tr> <tr> <td>MemberRemove</td> <td>MemberRemoveRequest</td> <td>MemberRemoveResponse</td> <td>MemberRemove 从集群中移除现有成员。</td> </tr> <tr> <td>MemberUpdate</td> <td>MemberUpdateRequest</td> <td>MemberUpdateResponse</td> <td>MemberUpdate 更新成员配置。</td> </tr> <tr> <td>MemberList</td> <td>MemberListRequest</td> <td>MemberListResponse</td> <td>MemberList 列出集群中的所有成员。</td> </tr> <tr> <td>MemberPromote</td> <td>MemberPromoteRequest</td> <td>MemberPromoteResponse</td> <td>MemberPromote 将学习者成员（非投票成员）提升为 Raft 投票成员。</td> </tr> </tbody> </table> </div> <h5 id="service-kv-apietcdserverpbrpcproto">服务 <code>KV</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>Range</td> <td>RangeRequest</td> <td>RangeResponse</td> <td>Range 从键值存储中获取指定范围内的键。</td> </tr> <tr> <td>Put</td> <td>PutRequest</td> <td>PutResponse</td> <td>Put 将指定键写入键值存储。Put 请求会递增键值存储的修订版本，并在事件历史中生成一个事件。</td> </tr> <tr> <td>DeleteRange</td> <td>DeleteRangeRequest</td> <td>DeleteRangeResponse</td> <td>DeleteRange 从键值存储中删除指定范围内的键。删除请求会递增键值存储的修订版本，并为每个被删除的键在事件历史中生成一个删除事件。</td> </tr> <tr> <td>Txn</td> <td>TxnRequest</td> <td>TxnResponse</td> <td>Txn 在单个事务中处理多个请求。事务请求会递增键值存储的修订版本，并为每个完成的请求生成具有相同修订版本的事件。不允许在同一个事务中多次修改同一键。</td> </tr> <tr> <td>Compact</td> <td>CompactionRequest</td> <td>CompactionResponse</td> <td>Compact 对 etcd 键值存储中的事件历史进行压缩。键值存储应定期执行压缩，否则事件历史将无限增长。</td> </tr> </tbody> </table> </div> <h5 id="service-lease-apietcdserverpbrpcproto">服务 <code>Lease</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>LeaseGrant</td> <td>LeaseGrantRequest</td> <td>LeaseGrantResponse</td> <td>LeaseGrant 创建一个租约，若服务器在指定的生存时间（TTL）内未收到保活请求，则该租约将过期。若租约过期，所有关联该租约的键将被过期并删除。每个过期的键都会在事件历史中生成一个删除事件。</td> </tr> <tr> <td>LeaseRevoke</td> <td>LeaseRevokeRequest</td> <td>LeaseRevokeResponse</td> <td>LeaseRevoke 撤销一个租约。所有关联该租约的键将过期并被删除。</td> </tr> <tr> <td>LeaseKeepAlive</td> <td>LeaseKeepAliveRequest</td> <td>LeaseKeepAliveResponse</td> <td>LeaseKeepAlive 通过客户端向服务器流式发送保活请求，并从服务器流式接收保活响应，以维持租约的活跃状态。</td> </tr> <tr> <td>LeaseTimeToLive</td> <td>LeaseTimeToLiveRequest</td> <td>LeaseTimeToLiveResponse</td> <td>LeaseTimeToLive 获取租约信息。</td> </tr> <tr> <td>LeaseLeases</td> <td>LeaseLeasesRequest</td> <td>LeaseLeasesResponse</td> <td>LeaseLeases 列出所有现有的租约。</td> </tr> </tbody> </table> </div> <h5 id="service-maintenance-apietcdserverpbrpcproto">服务 <code>Maintenance</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>Alarm</td> <td>AlarmRequest</td> <td>AlarmResponse</td> <td>告警用于激活、停用和查询与集群健康状态相关的告警。</td> </tr> <tr> <td>Status</td> <td>StatusRequest</td> <td>StatusResponse</td> <td>状态用于获取成员的状态。</td> </tr> <tr> <td>Defragment</td> <td>DefragmentRequest</td> <td>DefragmentResponse</td> <td>碎片整理用于对成员的后端数据库进行碎片整理，以恢复存储空间。</td> </tr> <tr> <td>Hash</td> <td>HashRequest</td> <td>HashResponse</td> <td>哈希用于计算整个后端键空间的哈希值，包括存储中的键、租约及其他桶。此功能仅用于测试！请勿在存在持续事务的生产环境中依赖此操作，因为哈希操作不持有 MVCC 锁。如需对“键”桶进行一致性检查，请改用“HashKV” API。</td> </tr> <tr> <td>HashKV</td> <td>HashKVRequest</td> <td>HashKVResponse</td> <td>哈希键用于计算指定修订版本之前所有 MVCC 键的哈希值。它仅遍历后端存储中的“键”桶。</td> </tr> <tr> <td>Snapshot</td> <td>SnapshotRequest</td> <td>SnapshotResponse</td> <td>快照通过流将成员的整个后端数据发送给客户端。</td> </tr> <tr> <td>MoveLeader</td> <td>MoveLeaderRequest</td> <td>MoveLeaderResponse</td> <td>转移领导者用于请求当前领导者将其领导权转移给指定接收节点。</td> </tr> <tr> <td>Downgrade</td> <td>DowngradeRequest</td> <td>DowngradeResponse</td> <td>降级用于请求降级、验证可行性或取消集群版本的降级操作。自 etcd 3.5 起支持。</td> </tr> </tbody> </table> </div> <h5 id="service-watch-apietcdserverpbrpcproto">服务 <code>Watch</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>Watch</td> <td>WatchRequest</td> <td>WatchResponse</td> <td>Watch 用于监听发生的事件或已发生的事件。输入和输出均为流；输入流用于创建和取消监听器，输出流用于发送事件。一个 Watch RPC 可以同时监听多个键范围，一次性流式传输多个监听的事件。可以从最后一次压缩的修订版本开始，监听完整的事件历史。</td> </tr> </tbody> </table> </div> <h5 id="message-alarmmember-apietcdserverpbrpcproto">消息 <code>AlarmMember</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>memberID</td> <td>memberID 是与触发告警相关的成员的 ID。</td> <td>uint64</td> </tr> <tr> <td>alarm</td> <td>alarm 是已触发的告警类型。</td> <td>AlarmType</td> </tr> </tbody> </table> </div> <h5 id="message-alarmrequest-apietcdserverpbrpcproto">消息 <code>AlarmRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>action</td> <td>action 表示要发出的告警请求类型。action 可以是获取告警状态、激活告警，或停用已触发的告警。</td> <td>AlarmAction</td> </tr> <tr> <td>memberID</td> <td>memberID 表示与告警关联的成员 ID。如果 memberID 为 0，则该告警请求涵盖所有成员。</td> <td>uint64</td> </tr> <tr> <td>alarm</td> <td>alarm 表示本次请求所考虑的告警类型。</td> <td>AlarmType</td> </tr> </tbody> </table> </div> <h5 id="message-alarmresponse-apietcdserverpbrpcproto">消息 <code>AlarmResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>alarms</td> <td>alarms 是与告警请求相关联的告警列表。</td> <td>(slice of) AlarmMember</td> </tr> </tbody> </table> </div> <h5 id="message-authdisablerequest-apietcdserverpbrpcproto">消息 <code>AuthDisableRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authdisableresponse-apietcdserverpbrpcproto">消息 <code>AuthDisableResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authenablerequest-apietcdserverpbrpcproto">消息 <code>AuthEnableRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authenableresponse-apietcdserverpbrpcproto">消息 <code>AuthEnableResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authroleaddrequest-apietcdserverpbrpcproto">消息 <code>AuthRoleAddRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name 是要添加到身份认证系统中的角色名称。</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authroleaddresponse-apietcdserverpbrpcproto">消息 <code>AuthRoleAddResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authroledeleterequest-apietcdserverpbrpcproto">消息 <code>AuthRoleDeleteRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authroledeleteresponse-apietcdserverpbrpcproto">消息 <code>AuthRoleDeleteResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegetrequest-apietcdserverpbrpcproto">消息 <code>AuthRoleGetRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegetresponse-apietcdserverpbrpcproto">消息 <code>AuthRoleGetResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>perm</td> <td></td> <td>(切片) authpb.Permission</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegrantpermissionrequest-apietcdserverpbrpcproto">消息 <code>AuthRoleGrantPermissionRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name 是将被授予权限的角色名称。</td> <td>string</td> </tr> <tr> <td>perm</td> <td>perm 是要授予角色的权限。</td> <td>authpb.Permission</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegrantpermissionresponse-apietcdserverpbrpcproto">消息 <code>AuthRoleGrantPermissionResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authrolelistrequest-apietcdserverpbrpcproto">消息 <code>AuthRoleListRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authrolelistresponse-apietcdserverpbrpcproto">消息 <code>AuthRoleListResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>roles</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> </div> <h5 id="message-authrolerevokepermissionrequest-apietcdserverpbrpcproto">消息 <code>AuthRoleRevokePermissionRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> <tr> <td>key</td> <td></td> <td>bytes</td> </tr> <tr> <td>range_end</td> <td></td> <td>bytes</td> </tr> </tbody> </table> </div> <h5 id="message-authrolerevokepermissionresponse-apietcdserverpbrpcproto">消息 <code>AuthRoleRevokePermissionResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authstatusrequest-apietcdserverpbrpcproto">消息 <code>AuthStatusRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authstatusresponse-apietcdserverpbrpcproto">消息 <code>AuthStatusResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>enabled</td> <td></td> <td>bool</td> </tr> <tr> <td>authRevision</td> <td>authRevision 是认证存储系统的当前修订版本</td> <td>uint64</td> </tr> </tbody> </table> </div> <h5 id="message-authuseraddrequest-apietcdserverpbrpcproto">消息 <code>AuthUserAddRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>password</td> <td></td> <td>string</td> </tr> <tr> <td>options</td> <td></td> <td>authpb.UserAddOptions</td> </tr> <tr> <td>hashedPassword</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuseraddresponse-apietcdserverpbrpcproto">消息 <code>AuthUserAddResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authuserchangepasswordrequest-apietcdserverpbrpcproto">消息 <code>AuthUserChangePasswordRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name 是要更改密码的用户的名称。</td> <td>string</td> </tr> <tr> <td>password</td> <td>password 是用户的新密码。请注意，该字段将在 API 层被移除。</td> <td>string</td> </tr> <tr> <td>hashedPassword</td> <td>hashedPassword 是用户的新的哈希密码。请注意，该字段将在 API 层被初始化。</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserchangepasswordresponse-apietcdserverpbrpcproto">消息 <code>AuthUserChangePasswordResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authuserdeleterequest-apietcdserverpbrpcproto">消息 <code>AuthUserDeleteRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name 是要删除的用户名称。</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserdeleteresponse-apietcdserverpbrpcproto">消息 <code>AuthUserDeleteResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authusergetrequest-apietcdserverpbrpcproto">消息 <code>AuthUserGetRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authusergetresponse-apietcdserverpbrpcproto">消息 <code>AuthUserGetResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>roles</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> </div> <h5 id="message-authusergrantrolerequest-apietcdserverpbrpcproto">消息 <code>AuthUserGrantRoleRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>user</td> <td>user 是应被授予指定角色的用户名。</td> <td>string</td> </tr> <tr> <td>role</td> <td>role 是应授予用户的角色名称。</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authusergrantroleresponse-apietcdserverpbrpcproto">消息 <code>AuthUserGrantRoleResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authuserlistrequest-apietcdserverpbrpcproto">消息 <code>AuthUserListRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authuserlistresponse-apietcdserverpbrpcproto">消息 <code>AuthUserListResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>users</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserrevokerolerequest-apietcdserverpbrpcproto">消息 <code>AuthUserRevokeRoleRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserrevokeroleresponse-apietcdserverpbrpcproto">消息 <code>AuthUserRevokeRoleResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authenticaterequest-apietcdserverpbrpcproto">消息 <code>AuthenticateRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>password</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authenticateresponse-apietcdserverpbrpcproto">消息 <code>AuthenticateResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>token</td> <td>token 是可用于后续 RPC 的授权令牌</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-compactionrequest-apietcdserverpbrpcproto">消息 <code>CompactionRequest</code> (api/etcdserverpb/rpc.proto) </h5> <p>CompactionRequest 对键值存储执行压缩，直至指定的修订版本。所有修订版本小于压缩修订版本的已覆盖键将被移除。</p>https://pig.center/zh/docs/etcd/dev-guide/api_concurrency_reference_v3/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/zh/docs/etcd/dev-guide/api_concurrency_reference_v3/<p>本文 API 参考由命名的 <code>.proto</code> 文件自动生成。</p> <h5 id="service-lock-serveretcdserverapiv3lockv3lockpbv3lockproto">服务 <code>Lock</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <p>锁服务将客户端锁功能以 gRPC 接口的形式暴露。</p> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">方法</th> <th scope="col">请求类型</th> <th scope="col">响应类型</th> <th scope="col">描述</th> </tr> </thead> <tbody> <tr> <td>Lock</td> <td>LockRequest</td> <td>LockResponse</td> <td>Lock 在指定名称的锁上获取分布式共享锁。成功时，将返回一个唯一键，该键在调用方持有锁期间持续存在。该键可与事务配合使用，以确保对 etcd 的更新仅在持有锁所有权时发生。锁将持续持有，直至对键调用 Unlock，或与所有者关联的租约到期。</td> </tr> <tr> <td>Unlock</td> <td>UnlockRequest</td> <td>UnlockResponse</td> <td>Unlock 接收 Lock 返回的键，并释放对锁的持有。等待获取锁的下一个 Lock 调用者将被唤醒，并获得锁的所有权。</td> </tr> </tbody> </table> </div> <h5 id="message-lockrequest-serveretcdserverapiv3lockv3lockpbv3lockproto">消息 <code>LockRequest</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>name 是要获取的分布式共享锁的标识符。</td> <td>bytes</td> </tr> <tr> <td>lease</td> <td>lease 是将附加到锁所有权的租约 ID。如果该租约到期或被撤销且当前持有锁，则锁会自动释放。使用相同租约调用 Lock 将被视为一次获取；使用相同租约两次锁定为无操作。</td> <td>int64</td> </tr> </tbody> </table> </div> <h5 id="message-lockresponse-serveretcdserverapiv3lockv3lockpbv3lockproto">消息 <code>LockResponse</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>etcdserverpb.ResponseHeader</td> </tr> <tr> <td>key</td> <td>键是在锁持有者持有锁期间存在于 etcd 中的键。用户不应修改此键，否则锁可能表现出未定义行为。</td> <td>bytes</td> </tr> </tbody> </table> </div> <h5 id="message-unlockrequest-serveretcdserverapiv3lockv3lockpbv3lockproto">消息 <code>UnlockRequest</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>key 是由 Lock 分配的锁所有权键。</td> <td>bytes</td> </tr> </tbody> </table> </div> <h5 id="message-unlockresponse-serveretcdserverapiv3lockv3lockpbv3lockproto">消息 <code>UnlockResponse</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">字段</th> <th scope="col">描述</th> <th scope="col">类型</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>etcdserverpb.ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="service-election-serveretcdserverapiv3electionv3electionpbv3electionproto">服务 <code>Election</code> (server/etcdserver/api/v3election/v3electionpb/v3election.proto) </h5> <p>选举服务通过 gRPC 接口向客户端暴露选举功能。</p>