调用DescribeLedger查询一个账本实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLedger |
系统规定参数。取值:DescribeLedger。 |
LedgerId | String | 是 | l-c8cc7be3eea542axxxxxxxxxx |
要查询的账本实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Ledger | Struct |
账本详细信息。 |
|
CreateTime | String | 1587515659345 |
账本创建时间。自1970年1月1日(00:00:00 GMT)以来的毫秒数。 |
JournalCount | Long | 100 |
账本总记录数。 |
LastTimeAnchor | Struct |
最新时间锚点信息。 |
|
JournalId | String | 50 |
时间锚点所在的记录ID。 |
LedgerDigest | String | f1e17070c100bd86538550252d94540481f7b81b852c859c906a44e416efdb86 |
账本摘要。 |
LedgerDigestType | String | SHA256 |
账本摘要类型。取值:SHA256。 |
LedgerVersion | String | 50 |
账本版本。 |
Proof | String | {"hashInHex":"aecdd0b65b7c0bd50bac1ac5d3cfa06ed78ce7cb270b3ca1110b2a6549242d49","sequence":52516} |
时间证据。 |
TimeStamp | String | 1587095881000 |
时间戳。自1970年1月1日(00:00:00 GMT)以来的毫秒数。 |
LedgerDescription | String | 这是我的第一个账本。 |
账本描述。 |
LedgerId | String | l-c8cc7be3eea542axxxxxxxxxx |
账本实例ID。 |
LedgerName | String | 账本1 |
账本名称。 |
LedgerStatus | String | NORMAL |
账本状态。取值:INVALID、NORMAL、DELETING、DELETED。INVALID状态表示账本还处于创建中,NORMAL状态表示该账本可正常可用,DELETING状态表示该账本处于删除中,DELETED状态表示该账本已删除。 |
LedgerType | String | JOURNAL |
账本类型。取值:KV、JOURNAL。KV类型的账本只能执行KV相关的数据操作,JOURNAL类型的账本只能执行JOURNAL相关的数据操作。 |
MemberCount | Long | 10 |
账本成员数目。 |
OwnerAliUid | String | 122435xxxxx |
账本的创建者的阿里云账户ID。 |
RegionId | String | cn-hangzhou |
账本所在的Region。 |
TimeAnchorCount | Long | 10 |
账本中时间锚点数量。 |
UpdateTime | String | 1587515659345 |
账本的最后更新时间。返回自1970年1月1日(00:00:00 GMT)以来的毫秒数。 |
ZoneId | String | cn-hangzhou-h |
账本实例所在的可用区ID。 |
RequestId | String | 89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeLedger
&LedgerId=l-c8cc7be3eea542axxxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C</RequestId>
<Ledger>
<JournalCount>100</JournalCount>
<ZoneId>cn-hangzhou-h</ZoneId>
<TimeAnchorCount>10</TimeAnchorCount>
<CreateTime>1587515659345</CreateTime>
<MemberCount>10</MemberCount>
<LedgerId>l-c8cc7be3eea542axxxxxxxxxx</LedgerId>
<LedgerDescription>这是我的第一个账本。</LedgerDescription>
<LastTimeAnchor>
<LedgerDigest>f1e17070c100bd86538550252d94540481f7b81b852c859c906a44e416efdb86</LedgerDigest>
<JournalId>50</JournalId>
<LedgerDigestType>SHA256</LedgerDigestType>
<Proof>{"hashInHex":"aecdd0b65b7c0bd50bac1ac5d3cfa06ed78ce7cb270b3ca1110b2a6549242d49","sequence":52516}</Proof>
<LedgerVersion>50</LedgerVersion>
<TimeStamp>1587095881000</TimeStamp>
</LastTimeAnchor>
<OwnerAliUid>122435xxxxx</OwnerAliUid>
<LedgerType>JOURNAL</LedgerType>
<UpdateTime>1587515659345</UpdateTime>
<RegionId>cn-hangzhou</RegionId>
<LedgerStatus>NORMAL</LedgerStatus>
<LedgerName>账本1</LedgerName>
</Ledger>
JSON
格式
{
"RequestId": "89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C",
"Ledger": {
"JournalCount": 100,
"ZoneId": "cn-hangzhou-h",
"TimeAnchorCount": 10,
"CreateTime": 1587515659345,
"MemberCount": 10,
"LedgerId": "l-c8cc7be3eea542axxxxxxxxxx",
"LedgerDescription": "这是我的第一个账本。",
"LastTimeAnchor": {
"LedgerDigest": "f1e17070c100bd86538550252d94540481f7b81b852c859c906a44e416efdb86",
"JournalId": 50,
"LedgerDigestType": "SHA256",
"Proof": "{\"hashInHex\":\"aecdd0b65b7c0bd50bac1ac5d3cfa06ed78ce7cb270b3ca1110b2a6549242d49\",\"sequence\":52516}",
"LedgerVersion": 50,
"TimeStamp": 1587095881000
},
"OwnerAliUid": "122435xxxxx",
"LedgerType": "JOURNAL",
"UpdateTime": 1587515659345,
"RegionId": "cn-hangzhou",
"LedgerStatus": "NORMAL",
"LedgerName": "账本1"
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter %s is invalid. | 参数无效 |
400 | MissingParameter | You must specify the parameter %s. | 参数缺失 |
404 | ResourceNotFound | The specified resource %s does not exist. | 资源不存在 |
403 | UnauthorizedOperation | You are not authorized to perform this operation. %s | 无操作权限 |
访问错误中心查看更多错误码。
访问错误中心查看更多错误码。