Canton 开发者文档 / 参考

完整文档页面（中文翻译）。文末附有来源说明。

阅读英文版

referencejson-api-referencedetails

Details and history

JSON Ledger API OpenAPI 端点详细信息和版本历史记录。

OpenAPI 参考

详细信息和历史记录

JSON Ledger API OpenAPI 表面的端点概述，根据版本化版本快照构建。

OpenAPI 
<span class="x2mdx-ref-badge x2mdx-ref-badge--neutral">3.5</span>
发布版本
3.5
<div class="x2mdx-ref-meta-item">
  <dt>来源</dt>
  <dd>Canton 发布捆绑包 JSON Ledger API 规范</dd>
</div>

<div class="x2mdx-ref-meta-item">
  <dt>版本过滤器</dt>
  <dd>3.4, 3.5</dd>
</div>

端点

从侧边栏中选择 OpenAPI 操作以获取请求和响应详细信息。本页总结了已配置的 Ledger API 版本中端点生命周期的变化。

/v2/commands/提交并等待

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：提交单个复合命令并等待其结果。传播失败提交的 gRPC 错误，包括 Daml 解释错误。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/commands/提交并等待交易

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：提交单个复合命令，等待其结果，然后返回交易。传播失败提交的 gRPC 错误，包括 Daml 解释错误。</p><dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/commands/提交并等待重新分配

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：提交单个复合重新分配命令，等待其结果，然后返回重新分配。传播提交失败的 gRPC 错误。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/commands/submit-and-wait-for-transaction-tree

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：提交一批命令并等待事务树响应。为向后兼容而提供，在Canton 3.5.0版本中将被删除，使用submit-and-wait-for...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/commands/async/submit

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：提交单个复合命令。</p><dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/commands/async/提交重新分配

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：提交单个重新分配。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/命令/完成

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：查询完成列表（阻塞调用）订阅命令完成事件。注意：此端点应用于小结果集。当结果数量超出节点配置时...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/events/events-by-contract-id

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：获取具有提供的 ID 的合约的创建和消费行使事件。对于已被修剪的合约，不会返回任何事件，因为它们已经被...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div><div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/版本

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：读取 Ledger API 版本</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/dars/验证

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：验证 DAR 并检查 DAR 软件包与目标审核同步器上已审核软件包集的升级兼容性。请参阅 ValidateDarFileReque...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/dars

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：上传 DAR 到参与者节点</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/包

获取、发布 
    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：返回所有支持的包的标识符。 POST：行为与 /dars 相同。此端点将在未来版本中弃用并删除。将 DAR 文件上传到粒子...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/packages/\{package-id}

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：返回单个包的内容。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/packages/\{package-id}/status

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：返回单个包的状态。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/package-vetting

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span><span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：列出哪个参与节点审查了哪个同步器上的哪些包。此端点 (GET /package-vetting) 已弃用，并将在未来版本中删除。请使用 POST /...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/package-vetting/list

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：列出哪个参与节点审查了哪个同步器上的哪些包。任何经过身份验证的用户都可以调用。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/package-vetting/update

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：更新该参与者的审核包</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/当事人

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div><p class="x2mdx-ref-card-summary">GET：列出参与者认识的各方。返回的列表包含由参与者促进其账本访问的各方以及在其他地方维护的各方。 POST：分配...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/partys/external/allocate

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：Alpha 3.3：在同步器上分配新外部方的端点预计在 3.5 中稳定外部方必须（至少）托管在此节点上，并通过以下任一确认...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/partys/参与方-id

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：返回参与者的标识符。所有水平扩展的副本应返回相同的 id。 daml-on-kv-ledger：返回启动时在命令行上提供的标识符...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/partys/\{party}

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、修补</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div><p class="x2mdx-ref-card-summary">GET：获取给定参与方的参与方详细信息。只有已知的各方才会返回到列表中。补丁：更新一方详细资源的选定可修改参与者本地属性...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、修补</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/partys/external/generate-topology

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：Alpha 3.3：用于生成外部签名拓扑交易的便捷端点预计在 3.5 中稳定您可以使用此端点生成通用外部拓扑...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/state/active-contracts

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：查询活跃合约列表（阻止调用）。查询活动合约是一项昂贵的操作，如果可能的话，不应经常重复。考虑查询活动合约...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/state/connected-同步器s

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span><span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：获取查询时已连接的同步器列表。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/state/ledger-end

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：获取当前账本结束。以返回的偏移量开始的订阅将在调用此 RPC 后提供事件服务。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/state/latest-pruned-offsets

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：获取最新成功修剪的账本偏移量</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/更新

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：读取账本的过滤更新流以获取指定的内容和过滤器。它根据所选的流内容返回事件类型。还有选择标准...</p><dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/更新/公寓

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：查询平面交易更新列表（阻止调用）。为了向后兼容，它将在 Canton 版本 3.5.0 中删除，改用 v2/updates。注意：此端点...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/更新/树

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：查询更新交易树列表（阻塞调用）。为了向后兼容，它将在 Canton 版本 3.5.0 中删除，改用 v2/updates。注意：此端点...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/transaction-tree-by-offset/\{offset}

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span><span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：按偏移量获取交易树。为了向后兼容，它将在 Canton 3.5.0 版本中删除，改用 v2/updates/update-by-offset。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/按偏移量交易

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：按偏移量获取交易。为了向后兼容，它将在 Canton 3.5.0 版本中删除，改用 v2/updates/update-by-offset。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/按偏移量更新

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：通过偏移量查找更新。如果此偏移量没有更新，或者所有事件都被过滤，则会引发 UPDATE\_NOT\_FOUND 错误。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/transaction-by-id

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span><span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：通过 ID 获取交易。为了向后兼容，它将在 Canton 3.5.0 版本中删除，改用 v2/updates/update-by-id。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/按 ID 更新

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：通过 ID 查找更新。如果没有使用此 ID 的更新，或者所有事件都被过滤，则会引发 UPDATE\_NOT\_FOUND 错误。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/updates/transaction-tree-by-id/\{update-id}

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已弃用</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：通过id获取交易树。为了向后兼容，它将在 Canton 3.5.0 版本中删除，改用 v2/updates/update-by-id。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/用户

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、发布</span><span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：列出所有现有用户。; POST：创建一个新用户。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/users/\{用户 ID}

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、删除、修补</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：获取特定用户或经过身份验证的用户的用户数据。删除：删除现有用户及其所有权限。补丁：更新用户资源的选定可修改属性...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、删除、修补</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/经过身份验证的用户

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：获取当前经过身份验证的用户的用户数据。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/users/\{用户 ID}/权限

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、发布、修补</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div><p class="x2mdx-ref-card-summary">GET：列出授予用户的所有权限集。 POST：向用户授予权限。授予权限不影响对应用户的资源版本；补丁：撤销...的权利</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、发布、修补</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/users/\{user-id}/identity-provider-id

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">补丁</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">补丁：将用户的分配从一个 IDP 更新到另一个 IDP。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>补丁</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/idps

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：列出所有现有身份提供商配置。; POST：创建新的身份提供商配置。如果单独配置的最大允许数量，则请求将失败...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/idps/\{idp-id}

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取、删除、修补</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div><p class="x2mdx-ref-card-summary">GET：通过id获取身份提供商配置数据；删除：删除现有的身份提供商配置。补丁：更新身份提供商的选定可修改属性...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取、删除、修补</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/交互式提交/准备

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：启用 LAPI 用户授权时，提交方需要 `readAs` 范围</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/交互式提交/执行

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：在账本上*异步*执行准备好的提交。需要提交外部方对交易进行签名。</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/interactive-submission/executeAndWait

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div><p class="x2mdx-ref-card-summary">POST：与 ExecuteSubmission 类似，但“同步”等待事务完成 重要：依赖此端点的响应需要信任参与者 N...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/interactive-submission/executeAndWaitForTransaction

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：与 ExecuteSubmissionAndWait 类似，但另外返回交易 重要提示：依赖此端点的响应需要信任参与者节点是诚实的...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/interactive-submission/preferred-package-version

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：首选包是所提供包名称的最高版本包，由托管所提供方的所有参与者进行审查。 Ledger API 客户端应该使用...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/interactive-submission/preferred-packages

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span><span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：计算请求中审核要求的首选套餐。首选包是所提供的包名称的最高版本的包，并且经过所有人的审查...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/livez

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.5 起</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：检查服务是否处于活动状态</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/readyz

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">获取</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.5 起</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">GET：检查服务是否准备好处理请求</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>获取</dd>
  </div>

  <div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

/v2/contracts/contract-by-id

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">发布</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4 起</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">更改为 3.5</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">POST：通过合约ID查找合约数据。此端点是实验性/alpha 版本，因此不保证向后兼容性。该端点不得用于查找合同...</p>

<dl class="x2mdx-ref-meta-grid">
  <div class="x2mdx-ref-meta-item">
    <dt>操作</dt>
    <dd>发布</dd>
  </div><div class="x2mdx-ref-meta-item">
    <dt>最后一次见到</dt>
    <dd>3.5</dd>
  </div>
</dl>

版本总结

3.4

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--linked">已添加 49</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">已更改 0</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已删除 0</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">此版本快照中包含端点更改。</p>

3.5

  <div class="x2mdx-ref-badges">
    <span class="x2mdx-ref-badge x2mdx-ref-badge--added">已添加 2</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--changed">已更改 49</span>

    <span class="x2mdx-ref-badge x2mdx-ref-badge--removed">已删除 0</span>
  </div>
</div>

<p class="x2mdx-ref-card-summary">此版本快照中包含端点更改。</p>

本文由 CC Privacy Club 根据 Canton Network 官方文档（CC-BY-4.0）整理翻译，仅供学习；实现细节以官方最新版本为准。