你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

List Ledger Entries - List Ledger Entries

从对应于某个范围的集合中获取账本条目。
可以选择指定集合 ID。 仅返回指定 (或默认) 集合中的条目。

GET {ledgerEndpoint}/app/transactions?api-version=2022-05-13
GET {ledgerEndpoint}/app/transactions?api-version=2022-05-13&collectionId={collectionId}&fromTransactionId={fromTransactionId}&toTransactionId={toTransactionId}

URI 参数

Name In Required Type Description
ledgerEndpoint
path True
  • string
url

机密账本 URL,例如 https://contoso.confidentialledger.azure.com

api-version
query True
  • string

要与 HTTP 请求一起使用的 API 版本。

collectionId
query
  • string

集合 ID。

fromTransactionId
query
  • string

指定区域中的第一个事务 ID。

toTransactionId
query
  • string

指定区域中的最后一个事务 ID。

响应

Name Type Description
200 OK

指定范围内的账本条目。

Other Status Codes

描述操作失败原因的错误响应

示例

ListLedgerEntries

Sample Request

GET {ledgerEndpoint}/app/transactions?api-version=2022-05-13&fromTransactionId=3.14&toTransactionId=3.42

Sample Response

{
  "state": "Ready",
  "nextLink": "/app/transactions?fromTransactionId=3.15&toTransactionId=3.42&collectionId=0&api-version=0.1-preview",
  "entries": [
    {
      "contents": "Ledger entry contents at transaction id 3.14.",
      "collectionId": "DEFAULT_SUBLEDGER",
      "transactionId": "3.14"
    }
  ]
}

定义

ConfidentialLedgerError

机密账本的错误响应。

ConfidentialLedgerErrorBody

机密账本的错误响应。

ConfidentialLedgerQueryState

账本查询的状态。

LedgerEntry

账本中的条目。

PagedLedgerEntries

响应查询时返回的分页账本条目。

ConfidentialLedgerError

机密账本的错误响应。

Name Type Description
error

机密账本的错误响应。

ConfidentialLedgerErrorBody

机密账本的错误响应。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

ConfidentialLedgerQueryState

账本查询的状态。

Name Type Description
Loading
  • string
Ready
  • string

LedgerEntry

账本中的条目。

Name Type Description
collectionId
  • string
contents
  • string

账本条目的内容。

transactionId
  • string

账本状态的唯一标识符。 如果作为 LedgerEntry 的一部分返回,则表示从中读取条目的状态。

PagedLedgerEntries

响应查询时返回的分页账本条目。

Name Type Description
entries

账本条目数组。

nextLink
  • string

从中检索下一页结果的路径。

state

账本查询的状态。