GetContract
账本API
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/zh/docs/canton/reference-grpc-ledger-api-reference-details">gRPC API</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<a href="/zh/docs/canton/reference-grpc-ledger-api-reference-com-daml-ledger-api-v2">v2</a>
<span class="x2mdx-ref-breadcrumb-separator">›</span>
<span>获取合同</span>
</div>
<div class="x2mdx-ref-hero">
<p class="x2mdx-ref-eyebrow">com.daml.ledger.api.v2</p>
<h1 class="x2mdx-ref-title">获取合同</h1>
<div class="x2mdx-ref-badges">
<span class="x2mdx-ref-badge x2mdx-ref-badge--protocol">gRPC</span>
<span class="x2mdx-ref-badge x2mdx-ref-badge--linked">自 3.4.11 起</span>
</div>
</div>
<div class="x2mdx-ref-operation-bar">
<span class="x2mdx-ref-operation-method x2mdx-ref-operation-method--rpc">RPC</span>
<code>/com.daml.ledger.api.v2.ContractService/GetContract</code>
</div>
## 协议详细信息
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>协议</dt>
<dd>gRPC</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>服务</dt>
<dd>合约服务</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>RPC</dt>
<dd>获取合同</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>客户端流</dt>
<dd>否</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>服务器流</dt>
<dd>否</dd>
</div>
</dl>
## 输入
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>获取合同请求</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>消息</dt>
<dd>com.daml.ledger.api.v2.GetContractRequest</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>客户端流</dt>
<dd>否</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">合约\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">查询\_party</code>
<span class="x2mdx-ref-type-badge">重复字符串</span>
</div>
</div>
</div>
</div>## 输出
<div class="x2mdx-ref-panel">
<div class="x2mdx-ref-panel-head">
<h3>获取合同响应</h3>
</div>
<dl class="x2mdx-ref-meta-grid">
<div class="x2mdx-ref-meta-item">
<dt>消息</dt>
<dd>com.daml.ledger.api.v2.GetContractResponse</dd>
</div>
<div class="x2mdx-ref-meta-item">
<dt>服务器流</dt>
<dd>否</dd>
</div>
</dl>
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">已创建\_event</code>
<span class="x2mdx-ref-type-badge">创建事件</span>
</div>
</div>
</div>
</div>
## 生命周期变化
<div class="x2mdx-ref-change-list">
<div class="x2mdx-ref-change-item">
<span class="x2mdx-ref-change-version">3.4.11</span>
<span class="x2mdx-ref-change-detail">引入</span>
</div>
</div>
## 相关模式
<手风琴组>
<手风琴标题=“com.daml.ledger.api.v2.GetContractRequest”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-getcontractrequest">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">合约\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">查询\_party</code>
<span class="x2mdx-ref-type-badge">重复字符串</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.GetContractResponse”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-getcontractresponse">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">已创建\_event</code>
<span class="x2mdx-ref-type-badge">创建事件</span>
</div>
</div>
</div>
</div>
</手风琴><手风琴标题=“com.daml.ledger.api.v2.CreatedEvent”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-createdevent">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">偏移量</code>
<span class="x2mdx-ref-type-badge">int64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">节点\_id</code>
<span class="x2mdx-ref-type-badge">int32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">合约\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">模板\_id</code>
<span class="x2mdx-ref-type-badge">标识符</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">合约\_key</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">合约\_key\_hash</code>
<span class="x2mdx-ref-type-badge">字节</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">创建\_arguments</code>
<span class="x2mdx-ref-type-badge">记录</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">已创建\_event\_blob</code>
<span class="x2mdx-ref-type-badge">字节</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">界面\_views</code>
<span class="x2mdx-ref-type-badge">重复的InterfaceView</span>
</div>
</div><div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">见证\_当事人</code>
<span class="x2mdx-ref-type-badge">重复字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">签署者</code>
<span class="x2mdx-ref-type-badge">重复字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">观察者</code>
<span class="x2mdx-ref-type-badge">重复字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">已创建\_at</code>
<span class="x2mdx-ref-type-badge">时间戳</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">包\_name</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">acs\_delta</code>
<span class="x2mdx-ref-type-badge">布尔</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">代表\_package\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.Identifier”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-identifier">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">包\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">模块\_name</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div><div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">实体\_name</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.Value”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-value">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">单位</code>
<span class="x2mdx-ref-type-badge">空</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">布尔</code>
<span class="x2mdx-ref-type-badge">布尔</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">int64</code>
<span class="x2mdx-ref-type-badge">sint64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">日期</code>
<span class="x2mdx-ref-type-badge">int32</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">时间戳</code>
<span class="x2mdx-ref-type-badge">sfixed64</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">数字</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">派对</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">文本</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div><div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">合约\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">可选</code>
<span class="x2mdx-ref-type-badge">可选</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">列表</code>
<span class="x2mdx-ref-type-badge">列表</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">文本\_map</code>
<span class="x2mdx-ref-type-badge">文本映射</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">gen\_map</code>
<span class="x2mdx-ref-type-badge">GenMap</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">记录</code>
<span class="x2mdx-ref-type-badge">记录</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">变体</code>
<span class="x2mdx-ref-type-badge">变体</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">枚举</code>
<span class="x2mdx-ref-type-badge">枚举</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.Optional”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-可选">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">值</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div>
</div>
</div>
</手风琴><手风琴标题=“com.daml.ledger.api.v2.List”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-list">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">元素</code>
<span class="x2mdx-ref-type-badge">重复值</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.TextMap”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-textmap">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">条目</code>
<span class="x2mdx-ref-type-badge">重复条目</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.TextMap.Entry”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-textmap-entry">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">密钥</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">值</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.GenMap”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-genmap">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">条目</code>
<span class="x2mdx-ref-type-badge">重复条目</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.GenMap.Entry”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-genmap-entry">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">密钥</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div><div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">值</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.Record”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-record">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">记录\_id</code>
<span class="x2mdx-ref-type-badge">标识符</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">字段</code>
<span class="x2mdx-ref-type-badge">重复记录字段</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.RecordField”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-recordfield">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">标签</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">值</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.Variant”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-variant">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">变体\_id</code>
<span class="x2mdx-ref-type-badge">标识符</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">构造函数</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div><div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">值</code>
<span class="x2mdx-ref-type-badge">值</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.Enum”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-enum">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">枚举\_id</code>
<span class="x2mdx-ref-type-badge">标识符</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">构造函数</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
</div>
</div>
</手风琴>
<手风琴标题=“com.daml.ledger.api.v2.InterfaceView”>
<div class="x2mdx-ref-schema" id="schema-com-daml-ledger-api-v2-interfaceview">
<div class="x2mdx-ref-fields">
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">接口\_id</code>
<span class="x2mdx-ref-type-badge">标识符</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">查看\_status</code>
<span class="x2mdx-ref-type-badge">状态</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">视图\_值</code>
<span class="x2mdx-ref-type-badge">记录</span>
</div>
</div>
<div class="x2mdx-ref-field-row">
<div class="x2mdx-ref-field-main">
<code class="x2mdx-ref-field-name">实现\_package\_id</code>
<span class="x2mdx-ref-type-badge">字符串</span>
</div>
</div>
</div>
</div>
</手风琴>
</手风琴组>
grpcurl
```bash grpcurl theme={"theme":{"light":"github-light","dark":"github-dark"}}
# Add -plaintext if the server is not using TLS.
grpcurl \
-d @ \
<div className="x2mdx-ref-rail-panel">
<div className="x2mdx-ref-rail-code x2mdx-ref-rail-code--response">
<div className="x2mdx-ref-rail-head">
<span className="x2mdx-ref-rail-heading">确定</span>
<span className="x2mdx-ref-response-label">application/json</span>
</div>
```json OK theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
"createdEvent": {
"offset": "0",
"nodeId": 0,
"contractId": "string",
"templateId": {
"packageId": "string",
"moduleName": "string",
"entityName": "string"
},
"contractKey": {
"unit": "string"
},
"contractKeyHash": "BASE64_ENCODED_BYTES",
"createArguments": {
"recordId": {
"packageId": "string",
"moduleName": "string",
"entityName": "string"
},
"fields": [
{
"label": "string",
"value": {}
}
]
},
"createdEventBlob": "BASE64_ENCODED_BYTES"
}
}
```
</div>
</div>本文由 CC Privacy Club 根据 Canton Network 官方文档（CC-BY-4.0）整理翻译，仅供学习；实现细节以官方最新版本为准。