此篇内容尚无原站英文对应版本;切换语言后可浏览英文资料库。
该
可能的错误:
ledger_entry方法以原始格式从STM分类帐返回单个分类帐对象。请参阅分类帐格式了解有关可检索的不同类型对象的信息。
注意:此方法没有命令行版本。您可以使用该json命令从命令行访问此方法。
请求格式的示例:
{
"id": 3,
"command": "ledger_entry",
"type": "account_root",
"account_root": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
"ledger_index": "validated"
}
{
"method": "ledger_entry",
"params": [
{
"account_root": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
"ledger_index": "validated",
"type": "account_root"
}
]
}
该方法可以检索几种不同类型的数据。您可以通过传递适当的参数来选择要检索哪种类型的项目。具体而言,您应该提供以下其中一个字段:
index- 通过其唯一ID检索任何类型的分类帐对象account_root- 检索AccountRoot对象。这大致相当于account_info命令。directory- 检索包含其他分类账对象列表的DirectoryNodeoffer- 检索要约对象,该对象定义了兑换货币的要约stream_state- 检索StreamState对象,该对象跟踪两个帐户之间的(非STM)货币余额。
Field |
Type | Description |
|---|---|---|
index |
String | (可选)指定要检索的单个分类帐条目的唯一标识符。 |
account_root |
String - Address | (可选)指定要检索的AccountRoot对象。 |
directory |
Object or String | (可选)指定一个DirectoryNode。(DirectoryNode对象每个都包含它们包含的事物的ID列表。)如果是字符串,则以十六进制解释为目录的唯一索引。如果一个对象需要其中一个dir_root或者owner作为一个子字段,还可以选择一个sub_index子字段。 |
directory.sub_index |
Unsigned Integer | (可选)如果提供,跳到更高的“页面” 目录。 |
directory.dir_root |
String | (如果directory指定为对象并且directory.owner未提供,则是必需的)以十六进制字符串标识要检索的目录的唯一索引。 |
directory.owner |
String | (如果directory指定为对象directory.dir_root且未提供,则为必需)与此目录关联的帐户的唯一地址 |
offer |
Object or String | (可选)指定要检索的Offer对象。如果是字符串,则解释为要约的唯一索引。如果某个对象需要子字段account并seq唯一标识该提议。 |
offer.account |
String - Address | (如果offer指定,则为必填项)提交报价的帐户。 |
offer.seq |
Unsigned Integer | (如果offer指定,则为必需)创建Offer对象的事务的序列号。 |
stream_state |
Object | (可选)指定要检索的StreamState(信任线)对象的对象。必须accounts和currency子字段唯一地指定要检索的StreamState条目。 |
stream_state.accounts |
Array | (如果stream_state指定,则为必需)帐户地址的2长度数组,定义由此StreamState对象链接的两个帐户 |
stream_state.currency |
String | (如果stream_state指定,则为必需)要检索的StreamState对象的货币代码。 |
binary |
Boolean | (可选)如果为true,则以十六进制字符串形式返回请求的分类帐对象的内容。否则,以JSON格式返回数据。缺省是true如果搜索index和false否则。 |
ledger_hash |
String | (可选)要使用的分类帐版本的20字节十六进制字符串。(请参阅指定分类帐) |
ledger_index |
String or Unsigned Integer | (可选)要使用的分类帐的序号或快捷字符串自动选择分类帐。(请参阅指定分类帐) |
generator和ledger参数已过时,可能在没有进一步的通知下被移除。
一个成功回应的例子:
{
"id": 3,
"result": {
"index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
"ledger_index": 156275,
"node": {
"Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
"Balance": "99999986731672268",
"Flags": 0,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 13,
"PreviousTxnID": "8D262E7AFD3E498C924EBA62F901FB4867C1CF04BD7248C8E894EDDD6320A376",
"PreviousTxnLgrSeq": 156245,
"Sequence": 308,
"index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037"
},
"validated": true
},
"status": "success",
"type": "response"
}
200 OK
{
"result": {
"index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037",
"ledger_index": 156275,
"node": {
"Account": "vDgSCaGS3iih9iKvfvRULrK7gurJjdDnUV",
"Balance": "99999986731672268",
"Flags": 0,
"LedgerEntryType": "AccountRoot",
"OwnerCount": 13,
"PreviousTxnID": "8D262E7AFD3E498C924EBA62F901FB4867C1CF04BD7248C8E894EDDD6320A376",
"PreviousTxnLgrSeq": 156245,
"Sequence": 308,
"index": "C2FA6D77327E553B9D611CA7BE4CC0CB33817EE23919EC09C48D10E4C5653037"
},
"validated": true
},
"status": "success",
}
响应遵循标准格式,成功结果包含以下字段:
Field |
Type | Description |
|---|---|---|
index |
String | 此ledger_entry的唯一标识键 |
ledger_index |
Unsigned Integer | 从中检索此数据的分类帐的唯一序号 |
node |
Object | (如果"binary": true指定,则省略)包含此分类帐对象数据的对象,根据分类帐格式。 |
node_binary |
String | (除非"binary":true指定,省略)分类帐对象的二进制数据,如十六进制。 |
- 任何通用错误类型。
invalidParams- 一个或多个字段指定不正确,或缺少一个或多个必填字段。lgrNotFound- 由ledger_hash或者ledger_index不存在的分类账,或者确实存在,但服务器没有。
