etcd官方文档中文版
  • Introduction
  • 官方文档
    • 开发指南
      • 搭建本地集群
      • 和 etcd 交互
      • 核心 API 参考文档
      • 并发 API 参考文档
      • gRPC 网关
      • gRPC 命名和发现
      • 试验性的 API 和特性
      • 系统限制
    • 运维指南
      • 搭建 etcd 集群
        • 运行时重配置
        • 运行时重配置的设计
      • 搭建 etcd 网关
      • 在容器内运行 etcd 集群
      • 配置
      • gRPC代理(TBD)
      • L4 网关
      • 支持平台
      • 硬件推荐(TBD)
      • 性能评测
      • 调优(TBD)
      • 安全模式
      • 基于角色的访问控制(TBD)
      • 常见问题(TBD)
      • 监控(TBD)
      • 维护
      • 理解失败
      • 灾难恢复
      • 版本
    • 学习
      • 为什么是etcd
      • 理解数据模型
      • 理解API
      • 术语
      • API保证
      • 认证子系统(TBD)
  • 核心 API 参考文档
    • KV service
      • Range方法
      • Put方法
      • DeleteRange方法
      • Txn方法
      • Compact方法
    • Watch service
      • Watch方法
    • Lease service
      • LeaseGrant方法
      • LeaseRevoke方法
      • LeaseKeepAlive方法
      • LeaseTimeToLive方法
  • 并发 API 参考文档
    • Lock service
      • Lock方法
      • Unlock方法
    • Election service
      • Campaign方法
      • Proclaim方法
      • Leader方法
      • Observe方法
      • Resign方法
  • 全文标签总览
Powered by GitBook
On this page
  • Response header
  • 键值 API
  • 键值对
  1. 官方文档
  2. 学习

理解API

Previous理解数据模型Next术语

Last updated 6 years ago

注意: 这个文档还没有完成!

注:原文如此,的确是还没有完成 :)

Response header

从etcd API返回的所有应答都附带有 。这个response header包含应答的元数据。

message ResponseHeader {
  uint64 cluster_id = 1;
  uint64 member_id = 2;
  int64 revision = 3;
  uint64 raft_term = 4;
}
  • Cluster_ID - 生成应答的集群的ID

  • Member_ID - 生成应答的成员的ID

  • Revision - 当应答生成时键值存储的修订版本

  • Raft_Term - 当应答生成时成员的 Raft term

应用可以读取 Cluster_ID (Member_ID) 字段来确保它正在和预期的集群(成员)通讯。

应用可以使用 Revision/修订版本 来获知键值存储最新的修订版本。当应用指定一个历史修订版本来实现 time travel query 并希望知道请求时刻最新的修订版本时有用。

应用可以使用 Raft_Term 来检测集群何时完成了新的leader选举。

键值 API

键值对

键值对是键值API可以操作的最小单元。每个键值对有一些字段:

message KeyValue {
  bytes key = 1;
  int64 create_revision = 2;
  int64 mod_revision = 3;
  int64 version = 4;
  bytes value = 5;
  int64 lease = 6;
}
  • Key - 字节数组形式的key。key不容许空。

  • Value - 字节数组形式的value

  • Version - key的版本。删除将重置版本为0而key的任何修改将增加它的版本。

  • Create_Revision - key最后一次创建的修订版本。

  • Mod_Revision - key最后一次修改的修订版本。

  • Lease - 附加到key的租约的ID。如果lease为0,则表示没有租约附加到key。

键值API用于操作etcd中的键值对存储。键值API被定义为 。在 中键值对被定义为结构化的数据。

response header
gRPC服务
protobuf 格式